Welcome! This is the development GitHub repository for SchoolTools, available at https://schooltools.lunarsphere.net/
If you'd like to set SchoolTools up for yourself, check the development setup guide and code licensing requirements
To set up code development for yourself, you should be running Linux, or a Linux container (such as WSL for Windows). Setting up is easy. Open a Linux terminal, and then:
- Make sure you have Node.js and npm installed. See the Node.js download page for more details.
- Clone this repository, using
git clone https://github.com/charnam/schooltools.git - Open the newly-created directory, using
cd schooltools/ - Run
npm installto download all required dependencies. - Finally, run
node index.jsto start the development server.
Upon making any changes to code in the server/ directory, you will need to interrupt and re-run node index.js to cause your changes to be reflected.
Note: AI-heavy pull requests may be completely ignored if effort is not put into human understanding of every line of added code. If a human wrote the code, they'd understand it. Unfortunately, so far, AI will often make mistakes and add unnecessary changes. It is up to you to verify and read your code, and up to me to make sure your changes function properly.
All code in this repository is licensed under the GNU aGPL version 3.0 or later.