Fastapi Piccolo

Overview:

This product is a practical example project that demonstrates the use of FastAPI and the Piccolo ORM. It also includes a simple frontend built with SvelteKit. The project utilizes various tools such as FastAPI, Piccolo ORM, Postgres, and SvelteKit to showcase the integration and functionality of these technologies.

Features:

• FastAPI: A high-performance web framework for building APIs with Python.
• Piccolo ORM: An easy-to-use asynchronous ORM (Object Relational Mapper) for Python.
• SvelteKit: A framework for building web applications using Svelte, a JavaScript compiler.

Installation:

To run the project, follow these steps:

1. Clone the repository.
2. Open your terminal and navigate to the project directory.
3. Run the following command to build the project: make build && make up.
4. To stop the Docker containers, run make down in your terminal. Please note that any data attached to the Docker containers will be lost.

It is important to note that the project requires certain environment variables to be set. The repository includes a sample.env file that contains the necessary environment variables. If you need to change these variables, make sure to update the Makefile to use the correct .env file for the make up command.

Summary:

This project serves as a practical example of using FastAPI and the Piccolo ORM together. It also includes a simple frontend built with SvelteKit. The project utilizes various tools such as FastAPI, Piccolo ORM, Postgres, and SvelteKit to showcase their integration and working capabilities. By following the provided installation guide, users can easily set up and run the project on their local machine.