๐ŸŽฏContribution

This page demonstrates Instructions to setup & contributing to the project.

What are the prerequisites ?

  • git (to clone the repository).

  • node <= v11.10.1

How to set up the project locally?

  1. Fork https://github.com/Ignitus/Ignitus-sideNavigation

  2. Clone git clone https://github.com/your_username/Ignitus-sideNavigation.git

  3. Once cloned navigate using cd Ignitus-sideNavigation

  4. Open terminal execute npm install

  5. Now execute npm start dev

  6. Navigate to http://localhost:3000 ๐Ÿš€

Tools ๐Ÿ”จ

A pluggable and configurable linter tool for identifying and reporting on patterns in JavaScript.

To run ESLint use.

npm run lint

This option instructs ESLint to automatically try to fix as many issues as possible. ๐Ÿ› 

npm run lint:fix

Please create a new branch from develop not from master, and please create a pull request to develop not to master.

A set of conventions (sometimes arbitrary) about how to write code for this project are mentioned here.

Last updated