https://github.com/falcopackages/falco

An opinionated toolkit for building web apps faster with Django.
https://github.com/falcopackages/falco

cookiecutter django htmx starter-kit starter-project starter-template webapp

Last synced: 11 months ago
JSON representation

An opinionated toolkit for building web apps faster with Django.

• Host: GitHub
• URL: https://github.com/falcopackages/falco
• Owner: falcopackages
• License: other
• Created: 2024-09-08T21:39:47.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-10-17T13:10:57.000Z (over 1 year ago)
• Last Synced: 2024-10-19T11:11:44.081Z (over 1 year ago)
• Topics: cookiecutter, django, htmx, starter-kit, starter-project, starter-template, webapp
• Language: Python
• Homepage: https://falco.oluwatobi.dev/
• Size: 3.5 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Contributing: docs/contributing.rst
  • License: LICENSE.txt
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
# Falco

> [!IMPORTANT]

> Work in progress, not ready, not released yet, currently this is the place to go https://github.com/falcopackages/falco-cli

**An opinionated toolkit for a better Django developer experience**



[![CI](https://github.com/Tobi-De/falco/actions/workflows/ci.yml/badge.svg)](https://github.com/Tobi-De/falco/actions/workflows/ci.yml)

[![Publish Python Package](https://github.com/Tobi-De/falco/actions/workflows/publish.yml/badge.svg)](https://github.com/Tobi-De/falco/actions/workflows/publish.yml)

[![Documentation](https://readthedocs.org/projects/falco-app/badge/?version=latest&style=flat)](https://beta.readthedocs.org/projects/falco-app/builds/?version=latest)

[![pypi](https://badge.fury.io/py/falco-app.svg)](https://pypi.org/project/falco-app/)

[![Hatch project](https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg)](https://github.com/pypa/hatch)

[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)

[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/Tobi-De/falco/blob/main/LICENSE)

[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/falco-app)](https://pypi.org/project/falco-app/)

[![PyPI - Versions from Framework Classifiers](https://img.shields.io/pypi/frameworkversions/django/falco-app)](https://pypi.org/project/falco-app/)

[![PyPI - Downloads](https://img.shields.io/pypi/dm/falco-app)](https://pypistats.org/packages/falco-app)

Falco is an opinionated toolkit designed to speed up web app development with Django. It helps you get to production in just a few minutes while keeping your project close to the standard Django structure, keeping things simple and manageable.

## 🚀 Features

- Django 5.1 and Python 3.11 support

- Email Login via [django-allauth](https://django-allauth.readthedocs.io/en/latest/)

- Integration with `htmx` using `django-htmx`

- [CRUD View Generation](https://falco.oluwatobi.dev/the_cli/crud.html) for your models with optional integrations with `django-tables2` and `django-filters`.

- Built-in **Project Versioning** with `bump2version`, Git integration, automatic changelog updates, and GitHub release creation.

- **Automated Deployment**: Deploy your project to a VPS (using [fabric](https://www.fabfile.org/)) or Docker-based platform with ease.

- Styling with [Tailwind CSS](https://tailwindcss.com/) (including [DaisyUI](https://daisyui.com/)) or [Bootstrap](https://getbootstrap.com/).

- And much more! Check out the full list of packages [here](https://falco.oluwatobi.dev/the_cli/start_project/packages.html)

## 📚 Table of Contents

- [Falco](#falco)

  - [🚀 Features](#-features)

  - [📚 Table of Contents](#-table-of-contents)

  - [📖 Installation](#-installation)

  - [♥️ Acknowledgements](#️-acknowledgements)

  - [👥 Contributors](#-contributors)

  - [📜 License](#-license)

## 📖 Installation

```console

pip install falco-app

```

Read the [documentation](https://falco.oluwatobi.dev) for more information on how to use Falco.

## ♥️ Acknowledgements

Falco is inspired by (and borrows elements from) some excellent open source projects:

- [django-twc-project](https://github.com/westerveltco/django-twc-project)

- [cookiecutter-django](https://github.com/cookiecutter/cookiecutter-django)

- [fuzzy-couscous](https://github.com/Tobi-De/fuzzy-couscous) (predecessor of falco)

- [django-hatch-startproject](https://github.com/oliverandrich/django-hatch-startproject)

- [django-unicorn](https://github.com/adamghill/django-unicorn) (Inspiration for the logo)

- [neapolitan](https://github.com/carltongibson/neapolitan)

- [django-base-site](https://github.com/epicserve/django-base-site)

- [django-cptemplate](https://github.com/softwarecrafts/django-cptemplate)

- [djangox](https://github.com/wsvincent/djangox)

## 👥 Contributors

[![All Contributors](https://img.shields.io/badge/all_contributors-9-orange.svg?style=flat-square)](#contributors-)

Thanks to the following wonderful people [emoji key](https://allcontributors.org/docs/en/emoji-key) who have helped build `falco`.

  

    

      
Tobi DEGNON
💻 📖 ⚠️

      
Muhammad Hammad
🤔

      
mathiasag7
💻

      
Richard Shea
📖

      
Waqar Khan
💻

      
tissieres
💵

      
Hsiaoming Yang
🐛

    

    

      
Aimé An-Nyong DEGBEY
🤔

      
Hana Belay
💻

    

  

## 📜 License

`falco` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.