TravBot-v3/docs/GettingStarted.md
2020-12-14 19:44:28 -06:00

700 B

Getting Started

  1. npm install
  2. npm run build
  3. npm start

Getting Started (Developers)

  1. npm install
  2. npm run dev
  3. Familiarize yourself with the project's structure.
  4. Make sure to avoid using npm run build! This will remove all your dev dependencies (in order to reduce space used). Instead, use npm run once to compile and build in non-dev mode.
  5. Begin developing.

Don't forget to...

  • ...update the changelog and any other necessary docs.
  • ...update the version numbers in package.json and package-lock.json.
  • ...make sure the test suite passes by running npm test.
  • ...format the code by running npm run format.