28 lines
1.1 KiB
Markdown
28 lines
1.1 KiB
Markdown
# BearlyPassing backend
|
|
|
|
_This small backend server acts as a translation layer between the frontend's REST API for fetching data, and PowerSchool's ancient SOAP API
|
|
|
|
Note: Some instances of PowerSchool no longer have a SOAP API, at this point it's a coin toss if your instance still supports it.
|
|
|
|
## Running_
|
|
|
|
```shell
|
|
python3 main.py
|
|
```
|
|
By default, it will listen for connections at `127.0.0.1:8080`. This can be changed by settings the `--address` and
|
|
`--port` arguments
|
|
|
|
This program supports sending CORS headers. Set the frontend-domain argument to the domain that you're hosting this
|
|
publicly on (read this whole section before deciding on hosting this)
|
|
|
|
```sh
|
|
python3 main.py --frontend-domain example.com
|
|
```
|
|
|
|
This backend should probably not be run in production, but if you do, for the love of all that is holy:
|
|
|
|
- Grep for todos in the code, there is some bounds checks we didn't add for simplicity
|
|
- Run this behind a reverse proxy
|
|
- Be extremely vigilant for unauthorised access
|
|
|
|
This program is licensed under GLWTPL, so don't point the finger at me if you get sued.
|