Skip to content

Commit

Permalink
Merge branch 'master' of github.com:nnsun/CourseGrab
Browse files Browse the repository at this point in the history
  • Loading branch information
nnsun committed Jul 11, 2017
2 parents 0baaa19 + 83fd5f0 commit b2682d3
Showing 1 changed file with 2 additions and 3 deletions.
5 changes: 2 additions & 3 deletions README.md
Expand Up @@ -37,13 +37,12 @@ The time-triggered notifier app is hosted in a [separate repository](https://git

6. Install the dependencies in requirements.txt.
```pip install -r requirements.txt```
Make sure that you also install [Microsoft ODBC Driver 13 for SQL Server](https://docs.microsoft.com/en-us/sql/connect/odbc/download-odbc-driver-for-sql-server).
You may need to also install an ODBC driver in order to access your SQL database.

7. Create a new project in the [Google App Engine](https://cloud.google.com/appengine/). In the API Manager, make a set of new OAuth2 client ID credentials. You will be given a client ID and a client secret. Next, add ```http://127.0.0.1:5000``` to the list of authorized JavaScript origins and ```http://127.0.0.1:5000/oauth2callback``` to the list of authorized redirect URIs.

8. Set up your global variables. CourseGrab uses a SQL Server database hosted in Azure, as well as a Google client secret and a SendGrid API key for sending notification emails. These are accessed via environment variables in order to avoid storing the credentials publically online.
ODBC is used to connect to the database, and the variables are as follows: ```DB_SERVER```, the database address; ```DB_NAME```, the name of the database; ```DB_USERNAME```, the username; and ```DB_PASSWORD```, the password. These values, along with
the Google OAuth 2.0 client secret, ```GOOGLE_CLIENT_SECRET```, are declared in the CourseGrab/CourseGrab/models/config.py file, which is imported by CourseGrab/CourseGrab/models/sql_client.py and CourseGrab/CourseGrab/\_\_init\_\_.py.
ODBC is used to connect to the database, and the variables are as follows: ```DB_SERVER```, the database address; ```DB_NAME```, the name of the database; ```DB_USERNAME```, the username; and ```DB_PASSWORD```, the password. These values are declared in the CourseGrab/CourseGrab/models/config.py file, which is imported by CourseGrab/CourseGrab/models/sql_client.py. The Google OAuth 2.0 client secret, ```GOOGLE_CLIENT_SECRET```, is located in CourseGrab/CourseGrab/config.py, and is imported by CourseGrab/CourseGrab/\_\_init\_\_.py. Also, change the consumer_key value in CourseGrab/CourseGrab/\_\_init\_\_.py to your Google App Engine client ID.
The SendGrid API key is ```SENDGRID_API_KEY```. This is only used in the Azure Functions script.

9. Start the local server.
Expand Down

0 comments on commit b2682d3

Please sign in to comment.