Installation Guide

This guide will help you install the necessary dependencies and assist you in setting up your application.


  • Python 3.9 or higher

Basic Installation

If you prefer to start a project from scratch, you can directly install the flect.

  1. Install flect

    To install the flect, run the following command in your terminal:

    pip install flect

Installation Using Project Template (Recommended)

For those who prefer to use a project template to kickstart their application, follow these steps:

Additional Requirements

  • Rye ( for dependency management
  • Cookiecutter ( for project scaffolding


  1. Create Project Structure

    Use Cookiecutter to create the project structure by running:

  2. Navigate to Project Directory

    Change into your project's directory:

    cd {project_slug}
  3. Synchronize Dependencies

    Use Rye to synchronize your project's dependencies:

    rye sync
  4. Run Your Application

    Start your application with Uvicorn:

    make dev
  5. Visit Your Application

    Open your browser and visit you will see the following page.


By following these steps, you can either set up your project from scratch or use a pre-defined template to get started quickly.