Skip to content

karthikbala/my-fastapi-app

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

My FastAPI App

This is a basic project structure for a FastAPI application. FastAPI is a modern, fast (high-performance), web framework for building APIs with Python 3.6+ based on standard Python type hints.

Project Structure

The project has the following structure:

my-fastapi-app
├── app
│   ├── main.py
│   ├── api
│   │   └── __init__.py
│   ├── models
│   │   └── __init__.py
│   └── services
│       └── __init__.py
├── tests
│   └── test_main.py
├── .gitignore
├── requirements.txt
└── README.md

Installation

To install the required dependencies, run the following command:

pip install -r requirements.txt

Running the Application

To run the application, navigate to the app directory and run the following command:

uvicorn main:app --reload

This will start the FastAPI application on your localhost.

Testing

To run the tests, navigate to the tests directory and run the following command:

pytest

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the terms of the MIT license.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages