https://github.com/heliumedu/template-project
A template Django project that can be initialized using `helium-cli`
https://github.com/heliumedu/template-project
aws aws-codedeploy django heliumcli python template-project
Last synced: 7 months ago
JSON representation
A template Django project that can be initialized using `helium-cli`
- Host: GitHub
- URL: https://github.com/heliumedu/template-project
- Owner: HeliumEdu
- License: mit
- Created: 2018-10-25T23:25:41.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2025-07-14T14:33:16.000Z (7 months ago)
- Last Synced: 2025-07-14T16:21:42.816Z (7 months ago)
- Topics: aws, aws-codedeploy, django, heliumcli, python, template-project
- Language: Python
- Homepage: https://github.com/HeliumEdu/heliumcli/wiki#template-project
- Size: 288 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.rst
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
[](https://codecov.io/gh/HeliumEdu/template-project)
[](https://github.com/HeliumEdu/template-project/actions/workflows/build.yml)
# template-project
## Getting Started
The project is developed using Python and [Django](https://www.djangoproject.com).
This repository contains the source code for the HeliumEdu `template-project`, which can be initialized using
[`helium-cli`](https://github.com/HeliumEdu/heliumcli) with:
```
helium-cli init
```
### Project Setup
To setup the Python/Django build environment, execute:
```sh
make install
```
This project is configured to work with a Virtualenv which has now been setup in the `venv` folder. If you're
unfamiliar with how this works, [read up on Virtualenv here](https://virtualenv.pypa.io/en/stable). The short version
is, virtualenv creates isolated environments for each project's dependencies. To activate and use this environment when
developing, execute:
```sh
source venv/bin/activate
```
All commands below will now be run within the virtualenv (though `make` commands will always automatically enter the
virtualenv before executing).
To ensure the database is in sync with the latest schema, database migrations are generated and run with Django. To run
migrations, execute:
```sh
make migrate
```
Once migrations have been run, you can create a super user, which is a standard user that also has access to the /admin
site.
```sh
python manage.py createsuperuser
```
Before commits are made, be sure to run tests and check the generated coverage report.
```sh
make test
```
Now you're all set! To start the development server, execute:
```sh
bin/runserver
```
A development server will be started at , though there is no mounted root URL—visit
or to see the project serve a request.
If the `USE_NGROK` environment variable is set when a dev server is started (using `runserver`),
[pyngrok](https://github.com/alexdlaird/pyngrok) will be used to open a `ngrok` tunnel. This is especially useful when
using webhooks.