GitHubContrib

The project is split into a Django API backend and a Vue.js 3 frontend built with Vite and Vuetify.

It allows you to have a profile page with your opensource contributions.

It also shows the number of stars you have for your repositories.

The website is live at https://githubcontrib.samarchyan.me.

See more documentation.

Development

You can use ubuntu-vm as a development VM if needed.

Also you can use macos-setup if you are on Mac.

1. Use mysql-docker to bring up MySQL in Docker
2. Use redis-docker to bring up Redis in Docker
3. Run make install-deps if necessary (only on Ubuntu)
4. Run make bootstrap
5. Run make createsuperuser to create a superadmin user
6. Edit files env_custom.sh and env_secrets.sh

Run make run to run the backend on http://localhost:8000/.

Run make dev to run the frontend on http://localhost:5173/.

Run make help to get a list of all available commands.

Open http://localhost:5173/ to access the web application.

Open http://localhost:8000/admin to access the admin section.

GitHub OAuth callback URLs should point at the backend, for example:

• http://localhost:8000/auth/complete/github/ for local development
• https://<backend-domain>/auth/complete/github/ for production

Set FRONTEND_URL to the frontend origin so the backend can redirect OAuth users back with JWT tokens.

Run in Docker:

1. Run make docker-build
2. Edit file docker_secrets.env
3. Run make docker-run

Production

To use production commands:

1. Edit file db_env_prod.sh
2. Activate the kubectl context