diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md new file mode 100644 index 0000000..eaad98d --- /dev/null +++ b/DEVELOPMENT.md @@ -0,0 +1,30 @@ +# Development + +## Getting started + +Go ahead do the following to clone the repository and install the project's dependencies: + +```bash +git clone https://github.com/ubclaunchpad/ubcsim2.git +npm install +``` + +You can run compilation, linter, and tests with: + +```bash +scripts/build_check.sh +``` + +## Build the app and deploy to GitHub Pages + +run the following command to build and deploy + +You can run your page locally using ```npm run start```, this will automatically rebuild your app as you change files and supports hot module replacement for fast development. + +OR + +To build your app and put resulted files in folder /build using ```npm run build``` . (If you ever changed your .ts or .html, rebuild to compile .ts files to .js). + +Deploy on GitHub Pages using ```npm run deploy``` +url: https://{github-account-name}.github.io/{repo-name} +https://ubclaunchpad.github.io/ubcsim2