https://github.com/devinit/ug-district-datahub
https://github.com/devinit/ug-district-datahub
Last synced: 8 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/devinit/ug-district-datahub
- Owner: devinit
- Created: 2023-02-21T13:32:52.000Z (about 3 years ago)
- Default Branch: dev
- Last Pushed: 2025-05-11T23:15:55.000Z (10 months ago)
- Last Synced: 2025-05-12T00:22:59.295Z (10 months ago)
- Language: HTML
- Size: 108 MB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# UG District DataHub
The Public Home of Uganda's District Data
## Environment Variables
To smoothly run the site, add the environment variables below to your `.env` file - with your own values of course.
| Name | Default |
|--------------|-----------|
| DATABASE_URL | |
| EMAIL_BACKEND| django.core.mail.backends.console.EmailBackend |
| EMAIL_HOST | smtp.gmail.com |
| EMAIL_HOST_USER | devinitautomailer@gmail.com |
| EMAIL_HOST_PASSWORD | |
| DEFAULT_FROM_EMAIL | devinitautomailer@gmail.com |
| DJANGO_SECRET_KEY | |
## Deployment
Deployment is done everytime changes are pushed (merged) into the `dev` branch by Github actions.
For first time deployment, set up a user on the server that will be used by Github Actions to deploy. We also advise to look at the `deploy_script.sh` script to see the process of deployment. You can run it from the server after cloning the repo. Make sure the directory where the repo is cloned into has the `.env` file set up with the values shown in the previous section.
Also, make sure the following secrets are set up in Github under the repo for continuous deployment to be effected;
| Name | Description |
|--------------|-----------|
| DEV_HOST | IP address of server where the dashboard will be deployed |
| DEV_USER| Username that will be used to log into the server |
| KEY | SSH Key to be used - preferably RSA format as it's supported by most Linux distros out of the box |
| PORT | SSH port |
We advise against using the root user to run the deployment. Set up a second user that will be used to run the update. Make sure the second user has permissions to spin up docker containers. Refer to the third option listed here - https://phoenixnap.com/kb/docker-permission-denied. Also, use nvm to install node `>=16 <17`.
## Analytics
This was setup for the dashboard pages. Nextcloud does not work with google analytics out of the box. The account information can be found on Edwin's APHRC handover notes.