amohapatra123 / codex-github

Contributions of Codex Members on Github

codex-github

Contributions of Codex members on Github

Resources Used

Build and Deploy

API Setup

• Create an OAuth app on Github
• Set environment value CLIENT_ID as the client_id of the OAuth app
• Set environment value CLIENT_SECRET as the client_secret of the OAuth app

Database Setup

• Create a MongoDB server. I've used MLab
• Set environment value MONGODB_URI to the MongoDB server url
• Create a collection members

Members setup

• Add the members you want to show in users.json
• Run python update.py
• Wait for it to populate the database

Run the app and deploy

• Install all dependencies pip install -r requirements.txt
• Run python app.py
• Browse to localhost:5000
• Deploy to your preferred platform. I've used heroku.

Updating and maintainance

• Create a scheduler to run python update.py every hour. (If it is run more than once an hour, you can get rate limited)
• Everytime you add a new name to the list, it is safer to manually run python update.py
  rather than wait for it to update at the next schedule