TravBot-v3/docs/GettingStarted.md

20 lines
650 B
Markdown
Raw Normal View History

# Getting Started
2020-10-15 09:23:24 +00:00
1. `npm install`
2. `npm run build`
3. `npm start`
# Getting Started (Developers)
2020-10-15 09:23:24 +00:00
1. `npm install`
2. `npm run dev`
2020-08-30 21:26:18 +00:00
3. Familiarize yourself with the [project's structure](Documentation.md).
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...
2020-10-15 09:23:24 +00:00
- ...update the [changelog](CHANGELOG.md) and any other necessary docs.
- ...update the version numbers in `package.json` and `package-lock.json`.
2020-10-15 09:23:24 +00:00
- ...make sure the test suite passes by running `npm test`.