Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wsvincent/djangox
Django starter project with 🔋
https://github.com/wsvincent/djangox
allauth django docker python starter-template whitenoise
Last synced: 3 months ago
JSON representation
Django starter project with 🔋
- Host: GitHub
- URL: https://github.com/wsvincent/djangox
- Owner: wsvincent
- License: other
- Created: 2018-02-15T17:29:07.000Z (almost 7 years ago)
- Default Branch: main
- Last Pushed: 2024-04-29T09:08:16.000Z (8 months ago)
- Last Synced: 2024-05-02T05:16:33.092Z (8 months ago)
- Topics: allauth, django, docker, python, starter-template, whitenoise
- Language: Python
- Homepage:
- Size: 24.2 MB
- Stars: 1,958
- Watchers: 61
- Forks: 383
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- stars - wsvincent/djangox - Django starter project with 🔋 (Python)
- stars - wsvincent/djangox - Django starter project with 🔋 (Python)
- awesome-boilerplate - GitHub
- awesome-boilerplate - GitHub
README
> A batteries-included Django starter project. To learn more visit [LearnDjango.com](https://learndjango.com).
https://github.com/wsvincent/djangox/assets/766418/a73ea730-a7b4-4e53-bf51-aa68f6816d6a
## 🚀 Features
- Django 5.1 & Python 3.12
- Install via [Pip](https://pypi.org/project/pip/) or [Docker](https://www.docker.com/)
- User log in/out, sign up, password reset via [django-allauth](https://github.com/pennersr/django-allauth)
- Static files configured with [Whitenoise](http://whitenoise.evans.io/en/stable/index.html)
- Styling with [Bootstrap v5](https://getbootstrap.com/)
- Debugging with [django-debug-toolbar](https://github.com/jazzband/django-debug-toolbar)
- DRY forms with [django-crispy-forms](https://github.com/django-crispy-forms/django-crispy-forms)
- Custom 404, 500, and 403 error pages
----
## Table of Contents
* **[Installation](#installation)**
* [Pip](#pip)
* [Docker](#docker)
* [Next Steps](#next-steps)
* [Contributing](#contributing)
* [Support](#support)
* [License](#license)
----
## 📖 Installation
DjangoX can be installed via Pip or Docker. To start, clone the repo to your local computer and change into the proper directory.
```
$ git clone https://github.com/wsvincent/djangox.git
$ cd djangox
```
### Pip
```
$ python -m venv .venv
# Windows
$ Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
$ .venv\Scripts\Activate.ps1
# macOS
$ source .venv/bin/activate
(.venv) $ pip install -r requirements.txt
(.venv) $ python manage.py migrate
(.venv) $ python manage.py createsuperuser
(.venv) $ python manage.py runserver
# Load the site at http://127.0.0.1:8000
```
### Docker
To use Docker with PostgreSQL as the database update the `DATABASES` section of `django_project/settings.py` to reflect the following:
```python
# django_project/settings.py
DATABASES = {
"default": {
"ENGINE": "django.db.backends.postgresql",
"NAME": "postgres",
"USER": "postgres",
"PASSWORD": "postgres",
"HOST": "db", # set in docker-compose.yml
"PORT": 5432, # default postgres port
}
}
```
The `INTERNAL_IPS` configuration in `django_project/settings.py` must be also be updated:
```python
# config/settings.py
# django-debug-toolbar
import socket
hostname, _, ips = socket.gethostbyname_ex(socket.gethostname())
INTERNAL_IPS = [ip[:-1] + "1" for ip in ips]
```
And then proceed to build the Docker image, run the container, and execute the standard commands within Docker.
```
$ docker compose up -d --build
$ docker compose exec web python manage.py migrate
$ docker compose exec web python manage.py createsuperuser
# Load the site at http://127.0.0.1:8000
```
## Next Steps
- Add environment variables. There are multiple packages but I personally prefer [environs](https://pypi.org/project/environs/).
- Add [gunicorn](https://pypi.org/project/gunicorn/) as the production web server.
- Update the [EMAIL_BACKEND](https://docs.djangoproject.com/en/4.0/topics/email/#module-django.core.mail) and connect with a mail provider.
- Make the [admin more secure](https://opensource.com/article/18/1/10-tips-making-django-admin-more-secure).
- `django-allauth` supports [social authentication](https://django-allauth.readthedocs.io/en/latest/providers.html) if you need that.
I cover all of these steps in tutorials and premium courses over at [LearnDjango.com](https://learndjango.com).
----
## 🤝 Contributing
Contributions, issues and feature requests are welcome! See [CONTRIBUTING.md](https://github.com/wsvincent/djangox/blob/master/CONTRIBUTING.md).
## ⭐️ Support
Give a ⭐️ if this project helped you!
## License
[The MIT License](LICENSE)