This is a FastAPI project built with Python 3.11. FastAPI is a modern, fast, web framework for building APIs with Python based on standard Python type hints. This project serves as a starting point for building scalable and high-performance APIs.
- FastAPI-based API with automatic validation, serialization, and documentation
- Python 3.11 with type hinting for enhanced code readability and maintainability
- Asynchronous support to handle high-concurrency scenarios
- Built-in Swagger UI and ReDoc for API documentation
- JWT authentication (Optional, if your project needs authentication)
- SQLAlchemy integration (Optional, if your project requires a database)
- Dockerized setup for easy deployment (Optional)
- Python 3.11
- Pip (package manager)
- Clone the repository:
git clone https://github.com/AltaraNg/fast-alt
cd fastapi-project- Create a virtual environment (optional but recommended):
python3.11 -m venv venv
source venv/bin/activate # On Windows, use `venv\Scripts\activate`- Install the dependencies:
pip install -r requirements.txt
The project includes a config.py file where you can configure various settings, such as database connection, JWT secret key, etc.
To run the FastAPI application, use the following command:
uvicorn main:app --reload
main is the name of the main module (e.g., the filename without the .py extension). app is the name of the FastAPI application instance. The API will be available at http://localhost:8000.
Swagger UI: http://localhost:8000/docs ReDoc: http://localhost:8000/redoc
sudo lsof -t -i tcp:7002 | xargs kill -9