Skip to content

Time Out Market is a market of shared JavaScript libraries to help you save time and effort

License

Notifications You must be signed in to change notification settings

juntossomosmais/time-out-market

Repository files navigation

readme-logo

Time Out Market

Release Status


Time Out Market is a market of shared JavaScript libraries to help you save time and effort

About

This project aims to create a market of shared JavaScript libraries to help you save time and effort. The libraries are created by Juntos Somos Mais community and can be used in our internal projects.

Packages

  • Linters - A set of linters configs to be used in our JavaScript projects

Development

Getting Started

  1. Clone the repository
  2. Install dependencies: npm install
  3. Create a new branch: git checkout -b my-new-branch
  4. Make your changes

Local testing using NPM Link

You can use the NPM Link to locally test any library. To illustrate, follow the steps below:

Link the library by navigating to the node_modules/@juntossomosmais/library-name directory, for example:

cd node_modules/@juntossomosmais/linters
npm link

Import library into your project by linking it using NPM Link. Navigate to your project's directory and run the following command example:

npm link @juntossomosmais/linters

This will create a symbolic link between your project and the local library.

Now, you can test the modifications in your project locally. Make sure to revert these changes and remove the NPM Link when you're done testing to avoid any conflicts or unexpected behavior with the actual installed library version in your project by running:

npm unlink

Following these steps, you can quickly test and verify any customizations or modifications you have made to the library locally using NPM Link.

Contributing

!important, as it's an internal project, we don't accept external suggestions to change or add new features.

We only accept contributions from Juntos Somos Mais members, but you could like our project and use it as a reference to build your own project.