https://github.com/desecho/githubcontrib
A profile page with your opensource contributions.
https://github.com/desecho/githubcontrib
django github opensource
Last synced: 6 months ago
JSON representation
A profile page with your opensource contributions.
- Host: GitHub
- URL: https://github.com/desecho/githubcontrib
- Owner: desecho
- Created: 2018-02-03T15:40:38.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2025-04-23T17:47:51.000Z (about 1 year ago)
- Last Synced: 2025-04-23T18:43:41.592Z (about 1 year ago)
- Topics: django, github, opensource
- Language: Python
- Homepage: https://githubcontrib.samarchyan.me
- Size: 1.38 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
Awesome Lists containing this project
README
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
----------------------------
* Orbitron_ for logo.
.. |Deployment Status| image:: https://github.com/desecho/githubcontrib/actions/workflows/deployment.yaml/badge.svg
:target: https://github.com/desecho/githubcontrib/actions/workflows/deployment.yaml
.. |Codecov| image:: https://codecov.io/gh/desecho/githubcontrib/branch/master/graph/badge.svg
:target: https://codecov.io/gh/desecho/githubcontrib
.. _documentation: https://github.com/desecho/githubcontrib/blob/master/doc.rst
.. _Vue.js: https://vuejs.org/
.. _Bootstrap: https://getbootstrap.com/
.. _Django: https://www.djangoproject.com/
.. _ubuntu-vm: https://github.com/desecho/ubuntu-vm
.. _macos-setup: https://github.com/desecho/macos-setup
.. _mysql-docker: https://github.com/desecho/mysql-docker
.. _redis-docker: https://github.com/desecho/redis-docker
.. _Orbitron: https://fonts.google.com/specimen/Orbitron
.. _Font Awesome: https://fontawesome.com/