https://github.com/stribny/sidewinder

Django starter kit that focuses on good defaults, developer experience, and deployment. Updated for Django 5.
https://github.com/stribny/sidewinder

ansible django django-rest-framework poetry pytest python starter-kit vps

Last synced: about 2 months ago
JSON representation

Django starter kit that focuses on good defaults, developer experience, and deployment. Updated for Django 5.

• Host: GitHub
• URL: https://github.com/stribny/sidewinder
• Owner: stribny
• License: mit
• Created: 2022-12-25T13:51:45.000Z (almost 2 years ago)
• Default Branch: master
• Last Pushed: 2024-04-27T18:38:43.000Z (8 months ago)
• Last Synced: 2024-05-23T09:59:47.017Z (7 months ago)
• Topics: ansible, django, django-rest-framework, poetry, pytest, python, starter-kit, vps
• Language: Python
• Homepage: https://stribny.github.io/sidewinder/
• Size: 1.83 MB
• Stars: 167
• Watchers: 4
• Forks: 10
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Sidewinder











> Configured Django on your own server in 10 minutes.




**Sidewinder** is an open-source [Django](https://www.djangoproject.com/) starter kit that focuses on good defaults, developer experience, and deployment. Also, [a snake](https://en.wikipedia.org/wiki/Crotalus_cerastes).

Sidewinder is opinionated to provide smooth experience from starting a new project to deploying it on a single Virtual Private Server (VPS). It is ideal for indie hackers, educators, students and the like.

With Sidewinder you will:

* Use all Django features like GeoDjango

* Use a modern Python dependency manager Poetry to manage your application's virtual environment

* Use environment variables instead of juggling multiple configuration files

* Use HTMX for modern frontends

* Use django-allauth to provide email-based and 3rd party authentication.

* Have a custom User model for ultimate flexibility

* Have Django REST Framework at your disposal right from the start, including modern API docs, standardized error responses, and CORS configuration

* Have a Huey task queue for background and periodic tasks

* Have state-of-the-art development tools including auto reloading, debugging and profiling tools, linters and formatters

* Log anything you want with structured logging

* Execute automated tests using the best testing library pytest

* Write test fixtures efficiently using factoryboy and Faker

* End-to-end test your frontend using Playwright

* Deploy to your own VPS in the "It just works" style using Ansible

* Have commands for backups and restores on your VPS

* Not be limited in customization as all important files are exposed and ready to be changed

### Documentation

[Documentation](https://stribny.github.io/sidewinder/)

### Development

Follow the development at [@stribny](https://twitter.com/stribny)