Skip to content

Commit f6c4de5

Browse files
committedJul 23, 2020
move old readme dev stuff to development
1 parent 3b1e61f commit f6c4de5

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed
 

‎DEVELOPMENT.md

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Development
2+
3+
## Getting started
4+
5+
Go ahead do the following to clone the repository and install the project's dependencies:
6+
7+
```bash
8+
git clone https://github.com/ubclaunchpad/ubcsim2.git
9+
npm install
10+
```
11+
12+
You can run compilation, linter, and tests with:
13+
14+
```bash
15+
scripts/build_check.sh
16+
```
17+
18+
## Build the app and deploy to GitHub Pages
19+
20+
run the following command to build and deploy
21+
22+
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.
23+
24+
OR
25+
26+
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).
27+
28+
Deploy on GitHub Pages using ```npm run deploy```
29+
url: https://{github-account-name}.github.io/{repo-name}
30+
https://ubclaunchpad.github.io/ubcsim2

0 commit comments

Comments
 (0)
Please sign in to comment.