GitHub

Installation Guide

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

Requirements

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

Install flect

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

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

Rye (https://rye-up.com/) for dependency management
Cookiecutter (https://cookiecutter.readthedocs.io/en/stable/) for project scaffolding

Create Project Structure

Use Cookiecutter to create the project structure by running:
```
cookiecutter https://github.com/Chaoyingz/cookiecutter-flect
```
Navigate to Project Directory

Change into your project's directory:
```
cd {project_slug}
```
Synchronize Dependencies

Use Rye to synchronize your project's dependencies:
```
rye sync
```
Run Your Application

Start your application with Uvicorn:
```
make dev
```
Visit Your Application

Open your browser and visit http://127.0.0.1:8000 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.