]> prime8.dev >> repos - csc.git/commitdiff
Update README.md
authorDamian Myrda <monkey.damianek@gmail.com>
Wed, 24 Apr 2024 20:01:19 +0000 (15:01 -0500)
committerGitHub <noreply@github.com>
Wed, 24 Apr 2024 20:01:19 +0000 (15:01 -0500)
README.md

index 956dfd27108eda69aaff5d5a5f5c31626953b901..3d561cd4813df2512358a5a264f8f70ef370612c 100644 (file)
--- 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```.