Awesome
<p align="center"> <a href="https://falco.oluwatobi.dev/"><img src="https://raw.githubusercontent.com/Tobi-De/falco/main/docs/_static/falco-logo.svg" alt="falco logo" height="200"/></a> </p> <h1 align="center"> <a href="https://falco.oluwatobi.dev">Falco</a> <p>An opinionated toolkit for a modern Django development experience</p> </h1>[!WARNING] The falco CLI isn't stable at the moment; stability is expected with the 1.0.0 release. I'm still making numerous changes quite frequently. If you're currently using it, remember to run
pip install --upgrade falco-cli
from time to time.
Falco is a Django-centric toolkit designed to enhance the development experience. The CLI offers commands for initiating new projects, generating simple CRUD views for rapid prototyping, and more. Additionally, it provides a collection of guides to address common issues in web development specifically tailored to Django.
<!-- [![Read the full documentation](https://img.shields.io/badge/Read%20The%20full%20Documentation-blue?style=for-the-badge&logo=ReadTheDocs)](https://falco.oluwatobi.dev) -->The CLI
This is a set of commands to help you throughout the lifecycle of your django project development, from bootstrapping a new project using modern tools like htmx, hatch, tailwindcss, to generating CRUD views for your models and a few utilities that might help during deployment.
For a brief introduction to the user experience of the CLI, visit this page.
<!-- [![The CLI full documentation](https://img.shields.io/badge/Read%20The%20CLI%20Documentation-blue?style=for-the-badge&logo=ReadTheDocs)](https://falco.oluwatobi.dev/the_cli/) -->pip install falco-cli
- start-project: Initialize a new django project the falco way.
- update-project: Update your project to get the latest falco features (experimental).
- start-app: Initialize a new django app the falco way.
- crud: Generate CRUD (Create, Read, Update, Delete) views for a model.
- install-crud-utils: Install utils necessary for CRUD views.
- work: Run all the services required to run your django project in parallel with a single command. (development only)
- htmx: Download a local copy of the latest version of htmx.
- htmx-ext: Download one of htmx extensions.
- sync-dotenv: Synchronize the
.env
file with the.env.template
file. - rm-migrations: Remove all migrations for the specified applications directory. (development only)
- reset-migrations: Delete and recreate all migrations. (development only)
Templates
The guides
[!NOTE] These are currently a work in progress. Most of them are half-written or not written at all. I hope to get them in a usable state
by the end of january 2024as soon as I can. To receive updates subscribe to this discussion or follow me on x or mastodon
If you don't find any use of the CLI, I hope you will in these guides. This is a collection of guides that address common issues in web development, specifically tailored to Django. Each guide provides solutions, patterns, and approaches that are relevant to Django projects. It is similar to the Django topic guides, but instead of focusing on components of the framework like forms
, models
, views
, etc., it focuses on more general topics like task queues
, deployment
, realtime
, etc.
- Interactive user interfaces
- Task Queues and Schedulers
- Writing documentation
- Writing tests
- Logging and monitoring
- The ultimate deployment guide
- Optimizing Database Access
- Business logic in django
- Dynamic Model Schema
- Realtime in Django: Websockets, SSE, Polling
- Permissions and authorizations
- Database Tips: Backup, Scaling, Triggers, and More
- Managing Multi-tenancy in Django
- Async Coding in Django
- Use Sqlite in production
- Running your project in a single container
- Tips and extra
Acknowledgements
Falco is inspired by (and borrows elements from) some excellent open source projects:
- cookiecutter-django
- fuzzy-couscous (predecessor of falco)
- django-hatch-startproject
- django-unicorn (Inspiration for the logo)
- neapolitan
- django-base-site
- django-twc-project
Contributors
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section --> <!-- ALL-CONTRIBUTORS-BADGE:END --> <!-- contributors:start -->Thanks to the following wonderful people emoji key who have helped build falco
.