]> 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 03:17:11 +0000 (22:17 -0500)
committerDamian Myrda <monkey.damianek@gmail.com>
Fri, 26 Apr 2024 03:17:11 +0000 (22:17 -0500)
1  2 
README.md

diff --cc README.md
index 6f3815d2fa717de2805d18b65ad0c4164020b995,99295ad9300101e344d01adc1a7488a822f65d40..b74b4361566077f66de79a7f6aa104f992363633
+++ b/README.md
@@@ -1,15 -1,11 +1,14 @@@
- # computer_science_club
- A website for Computer Science Club. It was made during a mini-hackathon.
+ # Computer Science Club Website
+ A website for Computer Science Club 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. Next, 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`.
 +
 +To setup Google OAuth2, goto [get google api clientid](https://developers.google.com/identity/oauth2/web/guides/get-google-api-clientid) and follow the instructions. Copy the json file into `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
 -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```.
 +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`.