From 4c76c75676237c8e8fe6113482a675dc8270b5d2 Mon Sep 17 00:00:00 2001 From: Damian Myrda Date: Thu, 25 Apr 2024 22:26:29 -0500 Subject: [PATCH] Update README.md --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f3ad965..1f5f08b 100644 --- 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 -- 2.43.4