📖 Liberty Framework Template

🚀 Overview

The Liberty Framework is a powerful, modular, and extensible framework built on FastAPI (backend) and React (frontend). It is designed to accelerate business application development by providing:

• Database Management 📦 – Built-in database handling for seamless integrations.
• Authentication & Security 🔐 – Secure user authentication and authorization.
• Real-Time Communication 📡 – WebSocket support for live updates.
• Scalability & Extensibility ⚡ – Easily extend with custom services and modules.

This template provides a quick and structured way to start a new Liberty Framework project with pre-configured backend and frontend components.

---

🚀 Getting Started

You can set up a new Liberty Framework project in multiple ways:

🔹 Option 1: Clone the Repository (Manual Setup)

1. Clone this repository:

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

2. Run the installation script:

   ./install.sh  # For macOS/Linux
   install.bat   # For Windows

3. Start the framework:

   ./start.sh    # For macOS/Linux
   start.bat     # For Windows

🔹 Option 2: Use npm (Recommended)

1. Run the following command to create a new project interactively:

   npm create myapps --template liberty-framework

2. Follow the prompts to set up your project.
3. Navigate to the project directory and start the framework:

   cd my-liberty-app
   ./start.sh    # macOS/Linux
   start.bat     # Windows

🔹 Option 3: Use npx (No Global Installation Required)

If you prefer not to install the package globally, use npx:

npx create-liberty-framework my-liberty-app

This will download and run the latest template without requiring a global installation.

---

📂 Project Structure

After installation, your project will have the following structure:

my-liberty-app/
├── app/        # FastAPI backend with API endpoints and database models
│   ├── main.py     # Entry point for FastAPI
│   ├── routes/     # API routes
│   ├── models/     # Database models
├── frontend/       # React frontend using Liberty Core components
│   ├── src/
│   │   ├── components/ # UI components
│   │   ├── pages/      # Application pages
│   ├── public/       # Static assets
├── setup/          # Installation UI
│   ├── src/
│   │   ├── SetupWizard.tsx  # UI for guided installation
├── install.sh      # Setup script for Linux/macOS
├── install.bat     # Setup script for Windows
├── start.sh        # Start script for Linux/macOS
├── start.bat       # Start script for Windows

---

🛠️ Requirements

To run Liberty Framework, ensure you have the following installed:

• Python 3.12+ 🐍
• Node.js 22+ 📦
• npm or yarn (for frontend dependencies)

To check if Python and Node.js are installed, run:

python3 --version
node --version

---

📌 Next Steps

• Read the Liberty Framework Documentation https://docs.nomana-it.fr/liberty 📚
• Explore the example apps link to examples 🏗️

Happy coding! 🚀

---

License

liberty-core is open-source software licensed under the AGPL License.

Copyright (c) 2025 NOMANA-IT and/or its affiliates.
All rights reserved. Use is subject to license terms.

---

📧 Contact & Support

If you have questions or need support:

• Email: franck.blettner@nomana-it.fr
• GitHub Issues: Report an issue
• Discussions: Join the conversation in the GitHub Discussions section.

---

💖 Sponsorship

If you find Liberty Core 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.

---