]> prime8.dev >> repos - csc.git/commitdiff
Update README.md
authorDamian Myrda <monkey.damianek@gmail.com>
Fri, 26 Apr 2024 03:26:29 +0000 (22:26 -0500)
committerGitHub <noreply@github.com>
Fri, 26 Apr 2024 03:26:29 +0000 (22:26 -0500)
README.md

index f3ad965efc3bf8f79c4136d50fe61d014c112e7f..1f5f08b6e8516c2109e0be28292544514883df9a 100644 (file)
--- a/README.md
+++ b/README.md
@@ -2,11 +2,13 @@
 A website for Computer Science Club made during a mini-hackathon.
 
 ## setup
-
+### environment
 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 jsonpickle cachecontrol google-auth google_auth_oauthlib` to install all the dependencies. Now, exit using by running `exit`.
 
+### schoology
 To get a Schoolopy API key and secret, goto `schoology.(PUT DOMAIN HERE).org/api`. There, you can manage your API credentials. Get the key and the secret.
 
+### google
 To setup Google OAuth2, go [here](https://developers.google.com/identity/oauth2/web/guides/get-google-api-clientid) and follow the instructions. Copy the json into a file called `google_auth.json` in the root of the project. In the `config.py` file in the directory of the project, change `REDIRECT_URL` to the url you used when you set up the google project.
 
 ## running