Skip to main content

Liberty Framework

Project description

📖 Liberty Framework

A Scalable and Extensible FastAPI and React Framework for Business Applications

🚀 Liberty Framework is a powerful, modular, and extensible FastAPI-based and React-based framework designed to streamline backend development for business applications. It provides database management, authentication, real-time socket communication, and more, making it easy to deploy and scale enterprise solutions.

Login = demo
Password = demo
Appplication = LIBERTY, NOMASX-1 and NOMAJDE

liberty


✨ Features

FastAPI-based – High-performance backend with asynchronous capabilities.
React-based – Beautiful and responsive frontend without any dependencies to components.
Database Management – SQLAlchemy, Alembic for migrations, and PostgreSQL support.
Real-Time Communication – Integrated WebSocket (Socket.IO) for live updates.
Authentication & Security – JWT authentication, encryption, and role-based access.
Automated Database Migrations – Alembic versioning for multiple databases.
Easy Installation & Deployment – Available as a Python package and Docker image.
Extensible – Plugin-based architecture to support future enhancements.

✨ Enterprise additional features

  • 🌐 Traefik: A powerful reverse proxy for routing and load balancing.
  • ⚙️ AirFlow: Automate and manage workflows effortlessly.
  • 🐘 pgAdmin: Manage your PostgreSQL database visually with ease.
  • 🔐 KeyCloak: OIDC Service for authentication
  • 📂 Gitea: Git Repository to manage dags, plugins, backup

📦 Installation

Requirements

A PostgreSQL 16 database is required. You can either:

  • Create a Docker image based on postgres:16, or
  • Install PostgreSQL 16 directly on your host system.

For easier setup and to ensure compatibility with future enterprise features, it is recommended to create a database with a user named liberty.

Option 1: Install via pip

pip install liberty-framework

🚀 Quick Start

After installation, you can start the framework with:

liberty-start

⚙️ URL

Installation URL

  • Setup: http://<your_host>:<your_port>/setup
  • Application: http://<your_host>:<your_port>
  • API Documentation: http://<your_host>:<your_port>/api
  • Swagger: http://<your_host>:<your_port>/api/test

Demo URL


📖 Documentation


🤝 Contributing

We welcome contributions! Here’s how you can help:

  1. Fork this repository.
  2. Clone your fork:
    git clone https://github.com/fblettner/liberty-framework.git
    
  3. Create a new branch for your feature:
    git checkout -b feature-name
    
  4. Commit your changes:
    git commit -m "Add new feature"
    
  5. Push to your fork and submit a Pull Request:
    git push origin feature-name
    
  6. Join discussions and help improve the framework!

💖 Sponsorship

If you find Liberty Framework useful and would like to support its development, consider sponsoring us. Your contributions help maintain the project, add new features, and improve the documentation. Every contribution, big or small, is greatly appreciated!

To sponsor, visit: GitHub Sponsors or reach out to us directly.


📜 License

Liberty Framework is open-source software licensed under the AGPL License.
Enterprise features require a license:

  • NOMASX-1: Security management, Segregation of duties and licenses compliancy
  • NOMAJDE JD-Edwards integration
  • Airflow Plugins: Automatic database backup, database synchronisation...
  • Liberty AI: Currently, OpenAI is set into the configuration, you have to use your own account without enterprise features license

📧 Contact & Support

If you have questions or need support:


⭐ If you find Liberty Framework useful, consider giving it a star on GitHub!

git clone https://github.com/fblettner/liberty-framework.git
cd liberty-framework

🚀 Let's build the future of business applications together! 🚀

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

liberty_framework-6.0.45.tar.gz (14.2 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

liberty_framework-6.0.45-py3-none-any.whl (14.3 MB view details)

Uploaded Python 3

File details

Details for the file liberty_framework-6.0.45.tar.gz.

File metadata

  • Download URL: liberty_framework-6.0.45.tar.gz
  • Upload date:
  • Size: 14.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.4

File hashes

Hashes for liberty_framework-6.0.45.tar.gz
Algorithm Hash digest
SHA256 e8dbea5e190f371d7c5c120b8419032e46c790a1614fc47369ad306544e6d46a
MD5 6045a75beade262fbd8e0fe37cd61acf
BLAKE2b-256 4628d6141252174d79468184b0b20dc2e9ede8cbca55b4d4925ad5baf03fc75c

See more details on using hashes here.

File details

Details for the file liberty_framework-6.0.45-py3-none-any.whl.

File metadata

File hashes

Hashes for liberty_framework-6.0.45-py3-none-any.whl
Algorithm Hash digest
SHA256 9cbe3dc812acf006fb7e9480cd1dcb2fa14c5e79c40cf7c4f2b0fb53fc75610b
MD5 dd3aa3a201590e08de4a994113618134
BLAKE2b-256 882b7aada14daa315205fc841895d5cd1f62734cda384e3f373b7ebf22792a41

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page