commit e69cc2b69cd64837c3b5ca620e30d1835893c007
parent 0b2a21cfa2088f5e06dd6c9eb460a3a23dfeb740
Author: Damian Myrda <damian@prime8.dev>
Date: Thu, 25 Apr 2024 22:26:29 -0500
Update README.md
Diffstat:
1 file changed, 3 insertions(+), 1 deletion(-)
diff --git 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
