chingu-voyage4 / Bears-Team-22

Voyage-4
1 stars 0 forks source link

Bears-Team-22

In this voyage we are cloning the JobBatical web site

Getting start

  1. Fork this project.
  2. Clone your fork and prepare it.
    > git clone https://github.com/YOUR_USERNAME/YOUR_FORK_NAME.git
    > cd YOUR_FORK_NAME
    > yarn install-all
    > yarn start

The project is divided into two parts; a front-end and a back-end.

The project can be run separately in different terminals but if you run from the root, gulp.js will take care of everything.

Contribution steps:

  1. Use the yarn package manager as we have used yarn to scaffold the app. See https://yarnpkg.com.
  2. Make a separate branch per feature added or bug fixed. Make a different PR for each so that we can track history better.
  3. DO NOT COMMIT CHANGES THAT BREAK THE RENDER
  4. Open a new issue for new features.
  5. Keep you commit messages meaningful
  6. Squash your commit if there are more than one.
  7. Running tests before commit is recommended.
  8. Do not commit package-lock.json as we are using yarn.lock
  9. Keep your environment vars in config.js file. If you add any config.js variables make sure to add them config.sample.js file for the references.
  10. Keep your fork up to date to avoid merge conflicts. Happy coding!!