| j | 7940eec | 2020-12-28 14:00:41 -0600 | [diff] [blame] | 1 | # Contributing
|
| 2 |
|
| j | 7940eec | 2020-12-28 14:00:41 -0600 | [diff] [blame] | 3 | ## Documentation
|
| 4 |
|
| j | 2e1cd83 | 2023-02-05 22:03:31 -0800 | [diff] [blame] | 5 | You can read the Power+ docs at [powerplus.app/docs/](https://powerplus.app/docs/).
|
| j | 7940eec | 2020-12-28 14:00:41 -0600 | [diff] [blame] | 6 |
|
| 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 |
|
| 18 | To get Power+ up and running locally, you'll need git and node installed on your system.
|
| 19 |
|
| 20 | ```bash
|
| j | 0e5b1c7 | 2026-10-13 03:49:38 +0000 | [diff] [blame^] | 21 | git clone https://src.jottocraft.com/dtps.git
|
| j | 7940eec | 2020-12-28 14:00:41 -0600 | [diff] [blame] | 22 | cd dtps
|
| 23 | npm install
|
| 24 | npm start
|
| 25 | ```
|
| 26 |
|
| 27 | When 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
|
| j | 2e1cd83 | 2023-02-05 22:03:31 -0800 | [diff] [blame] | 32 | - `deploy` Runs the build script, then deploys Power+ to the gh-pages branch for hosting |