sachnaror / fastapi-boilerplate-using-schema.sh

FastAPI boilerplate setup for quick project initiation

FASTAPI-BOILER_PLATE

THIS IS THE SAMPLE FASTAPI BOILER PLATE REFERECE TO START WITH YOUR PROJECT

Project Folder Structure

This project follows a systematic folder structure to ensure organization and maintainability. To set up this structure effortlessly, you can utilize the provided shell script.

Usage

Clone or download the project repository. Open a terminal or command prompt and navigate to the project's root directory. Run the following command to execute the shell script in the terminal:

Step1 : Provide the script with suitable permission

chmod +x /in/the/path/of/schema.sh

Step 2 : RUN the sh file

./schema.sh

The script will automatically create the necessary folders and files, establishing the boilerplate for your FastAPI project.

Getting Started

After running the shell script and setting up the folder structure, you can start developing your FastAPI project right away. Refer to the generated main.py file and the provided examples in each folder to understand how to structure your code and create API endpoints efficiently.

Happy coding!