Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alexdlaird/django-bootstrap-authentication-template-project
A simple template, including authentication forms, for a deployable Django application using Bootstrap
https://github.com/alexdlaird/django-bootstrap-authentication-template-project
ansible bootstrap django django-pipeline education heliumcli python travis-ci
Last synced: 19 days ago
JSON representation
A simple template, including authentication forms, for a deployable Django application using Bootstrap
- Host: GitHub
- URL: https://github.com/alexdlaird/django-bootstrap-authentication-template-project
- Owner: alexdlaird
- License: mit
- Created: 2014-08-25T15:38:35.000Z (about 10 years ago)
- Default Branch: main
- Last Pushed: 2024-09-16T10:46:58.000Z (2 months ago)
- Last Synced: 2024-10-07T08:12:06.112Z (about 1 month ago)
- Topics: ansible, bootstrap, django, django-pipeline, education, heliumcli, python, travis-ci
- Language: Python
- Homepage:
- Size: 297 KB
- Stars: 4
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
[](https://codecov.io/gh/alexdlaird/django-bootstrap-authentication-template-project)
[](https://github.com/alexdlaird/django-bootstrap-authentication-template-project/actions/workflows/build.yml)
# Django Bootstrap/Authentication Template Project
## Getting Started
The project is developed using [Python](https://www.python.org/), [Django](https://www.djangoproject.com), and [Bootstrap](http://getbootstrap.com/docs/3.3/).
This repository contains the source code for a Django Bootstrap/Authentication Template Project.
### 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. 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
```
### Development
To get started with minimal effort, assuming you have followed the "Getting Started" directions above, you should have the ENVIRONMENT environment
variable set to "dev". For convenience, [helium-cli](https://github.com/HeliumEdu/heliumcli#readme), which is compatible with this project and
provides a useful set of tools for maintaining, building, and deploying the code, has also been installed.
To start a local server, execute:
```sh
helium-cli start-servers
```
A development server will be started at .
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.
You can also deploy builds of the code using `helium-cli`, for instance, to deploy `main` to `stage`, execute:
```sh
helium-cli deploy-build main stage
```
[Ansible](https://www.ansible.com/) deployment scripts can be found in the `ansible` directory.
As a starting point for using this project as a template for a new project, search for usages of "MYPROJECT" and
begin refactoring from there.