commit 590e18cd444f676dda633d3cecd4c1233f12f9e5
parent d1405071362c93b6d99dd913c64fa44cdf6fbf27
Author: Damian Myrda <damian@prime8.dev>
Date: Wed, 24 Apr 2024 15:01:19 -0500
Update README.md
Diffstat:
1 file changed, 4 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
@@ -2,8 +2,10 @@
A website for Computer Science Club. It was made during a mini-hackathon.
## setup
-To setup the server environment, run ```python -m venv .``` in the root of the project. Then, execute ```. ./bin/activate``` and you should be in the virtual environment. Lastly, run ```pip install flask schoolopy``` to install all the dependencies. Now, exit using by running ```exit```.
+To setup the server environment, run ```python -m venv .``` in the root of the project. Then, execute ```. ./bin/activate``` and you should be in the virtual environment. Next, run ```pip install flask schoolopy``` to install all the dependencies. Now, exit using by running ```exit```.
## running
-To run the server, execute ```run.sh```.
+To run the server, you need an API key and its companioning secret. In your browser, go to ```schoology.(PUT DOMAIN HERE).org/api```. There, you can manage your API credentials. Get the key and secret and return.
+
+Now, you can execute ```SCHOOLOGY_API_KEY="PUT KEY HERE" SCHOOLOGY_API_SECRET="PUT SECRET HERE" ./run.sh```.
