Skip to content

Latest commit

 

History

History
149 lines (116 loc) · 5.46 KB

README.md

File metadata and controls

149 lines (116 loc) · 5.46 KB

📖 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

git clone https://github.com/fblettner/liberty-framework.git
go to backend directory and submit build.sh
pip install liberty-framework

Option 2: Run with Docker

docker pull ghcr.io/fblettner/liberty-framework:latest
docker run -p 8000:8000 ghcr.io/fblettner/liberty-framework

🚀 Quick Start

After installation, you can start the framework with:

liberty-start

or manually:

uvicorn app.main:app --host 0.0.0.0 --port 8000 --reload

⚙️ 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! 🚀