Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
tejaksha authored May 30, 2023
1 parent 0a26bc8 commit e7f48d1
Showing 1 changed file with 26 additions and 1 deletion.
27 changes: 26 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,26 @@
# FASTAPI-BOILER_PLATE
# 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!

0 comments on commit e7f48d1

Please sign in to comment.