This project is designed specifically for programs related to FastAPI. It aims to allow students to focus on learning FastAPI without worrying about environment setup. The project includes the necessary configurations and dependencies to start quickly and easily.
Make sure you have the following software installed on your machine:
The project is structured as follows:
requirements.txt
: Lists the Python dependencies required for the project.Dockerfile
: Contains the instructions to build the Docker image for the FastAPI application.docker-compose.yaml
: Defines the services and configurations for running the project using Docker Compose.app/
: Directory containing the FastAPI application code.members/
: Directory for storing each participant's assignments as Git submodules. Each participant should add their own repository as a submodule under members/
using the following steps in members/README.md.git clone <repository_url>
cd <repository_directory>
cp docker-compose.yaml.example docker-compose.yaml
mkdir -p app
touch app/requirements.txt
touch app/main.py
[!TIP] You can copy
requirements.txt.example
file intoapp
directory and rename toapp/requirements.txt
[!NOTE] Please make sure that
main.py
is not empty.
docker-compose up --build -d
The FastAPI application will be available at http://localhost:8080
.
The Dockerfile
sets up the environment for the FastAPI application. It includes the following key steps:
The docker-compose.yaml
file defines the services required for the application. It includes:
If you wish to contribute to this project, please follow these steps:
git checkout -b feature/your-feature
).git commit -am 'Add new feature'
).git push origin feature/your-feature
).For any questions or issues, please contact the project maintainer at nycu1sdc@gmail.com.