]> prime8.dev >> repos - csc.git/commitdiff
Merge branch 'master' of github.com:moncheeta/computer_science_club
authorDamian Myrda <monkey.damianek@gmail.com>
Fri, 26 Apr 2024 04:11:30 +0000 (23:11 -0500)
committerDamian Myrda <monkey.damianek@gmail.com>
Fri, 26 Apr 2024 04:11:30 +0000 (23:11 -0500)
1  2 
README.md

diff --cc README.md
index ee82b061bb35d8e33bd409cadd014804733ed3ed,bd23d93e45f95b199daa39a6668db9454acef97e..d3570ef80f75fa7b5006307c8c3753df80f54ac9
+++ b/README.md
@@@ -1,17 -1,15 +1,17 @@@
  # Computer Science Club Website
  A website for Computer Science Club made during a mini-hackathon.
  
 +![home page](./assets/home.png)
 +
  ## 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`.
+ 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`.
  
  ### 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.
In ```config.py```, change ```DOMAIN``` to the URL of the Schoology instance. In addition, change ```GROUP_ID``` to the ID of the Schoology group. This can be found by visiting the Schoology website and by navigating to the Schoology group. The group's ID should be right after the ```/group/...``` subdirectory of the domain. To get a Schoolopy API key and secret, goto `schoology.(PUT DOMAIN HERE).org/api`. There, you can manage your API credentials. You will need the key and secret to run the server.
  
  ### 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.
+ 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 `config.py`, change `REDIRECT_URL` to the URL you used when you set up the Google project. Make sure that the redirect URL is added as one of the "Authorized redirect URIs."
  
  ## running
  Now, you can execute `SCHOOLOGY_API_KEY="PUT KEY HERE" SCHOOLOGY_API_SECRET="PUT SECRET HERE" ./run.sh`.