blob: 6291401e62f793063c58788ace0f2cbb320456a7 [file] [log] [blame] [view]
j7940eec2020-12-28 14:00:41 -06001# Contributing
2
j7940eec2020-12-28 14:00:41 -06003## Documentation
4
j2e1cd832023-02-05 22:03:31 -08005You can read the Power+ docs at [powerplus.app/docs/](https://powerplus.app/docs/).
j7940eec2020-12-28 14:00:41 -06006
7## Code Organization
8
9- `/scripts` Power+ script files
10- `/scripts/lms` LMS integration files
11- `/www` Static website files
12- `/docs` JSDoc configuration
13- `/chrome` Chrome extension source
14- `/build` Public website and optimized JavaScript files generated by `npm run build`
15
16## Development Environment
17
18To get Power+ up and running locally, you'll need git and node installed on your system.
19
20```bash
j0e5b1c72026-10-13 03:49:38 +000021git clone https://src.jottocraft.com/dtps.git
j7940eec2020-12-28 14:00:41 -060022cd dtps
23npm install
24npm start
25```
26
27When the server is ready, open Power+ and go to Settings -> About -> Show Advanced Options -> Test prerelease versions. Then, reload Power+ and go to Settings -> Prerelease testing and select "Local". This will make Power+ load from the local server instead of the live version the next time you reload.
28
29## NPM scripts
30- `start` Starts an HTTP server for testing Power+ locally
31- `build` Minifies Power+ and generates docs into the build folder for deployment
j2e1cd832023-02-05 22:03:31 -080032- `deploy` Runs the build script, then deploys Power+ to the gh-pages branch for hosting