Skip to content

Latest commit

 

History

History
67 lines (49 loc) · 2.3 KB

README.rst

File metadata and controls

67 lines (49 loc) · 2.3 KB
Raw

GitHubContrib

Deployment Status Codecov

The web application on Django 4, Vue.js 3, Bootstrap 4, Font Awesome 6.

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 build and make run to run the server for development.
Run make help to get a list of all available commands.
Open http://localhost:8000/ to access the web application.
Open http://localhost:8000/admin to access the admin section.
Open http://localhost:8000/rosetta to access Rosetta.

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

Fonts used