/codex-github

Contributions of Codex Members on Github

Primary LanguagePython

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 maintenance

  • 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

Run in Docker

  • Adjust your users.json to list the users you want to include.

  • Build the image

    docker build -t codex-github .

  • Start a container as

    docker run --rm -e CLIENT_ID=<client id> -e CLIENT_SECRET=<client secret> -e MONGODB_URI=<MongoDB connection string> --name codex-update codex-github --update

    with the variables set as described above.

    This will update your local cache just like python update.py would.

  • Now, start the web app as

    docker run -d -e CLIENT_ID=<client id> -e CLIENT_SECRET=<client secret> -e MONGODB_URI=<MongoDB connection string> --name codex-app codex-github

Whenever you want to update you local user/repository cache, just run the first command again. Please be aware however that you will need to rebuild the container if you change the user list.

Members

Name Github Username
Sachiket Behera sachiket
Ritika Mandal Ritika432
Akshay akki031197
Jashaswee Jena jashasweejena
Salif Moin salif-04
Parag Bhattacharjee PsychoBoy5
Nehal Kumar Singh geekyNehal
Omm Mishra ommmishra
Simran Agrawal SimranAgrawal1
Shikha Kumari shikhanimmi
Kumar Arunav KumarArunav
Dipannita Mahata dipu-m18
Shikha Singh SHIKHASINGH1506
Anish Kumar Yadav anish-yadav
Swagat Parija swagat5147
Mohit Agarwal mojito9542
MD Azmal MD-AZMAL
Ankit Prasad Ankit289Prasad
Aruba Shireen aruba246
Ashis Padhi AshisPadhi
Pawan Kumar Pawan0411
Debashish Mishra Zanark
A Rupesh rupesh1310
Nirmal Kumar Bhakat Nirmal-Kr
Subhrajit Prusty SubhrajitPrusty
Dibya Ranjan Jena dibyasonu
Sudhansu alphacrash
Swaraj Laha swarajlaha
Srinibas Biswal srinibasbiswal
Sidharth xlreon
Ayush Mishra hsuay
Subhasish Sahu subhasish210

Screenshots