# Sidewinder

<br><br>

<p align="center"><img width="200" src='docs/sidewinder.png'/></p>

<br><br>

> Configured Django on your own server in 10 minutes.

<br>

**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 uv
* Use environment variables instead of juggling multiple configuration files
* 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)