This project is a basic setup using FastAPI and SQLAlchemy.
-
Create a Virtual Environment
- Use the
requirements.txt
file to create a virtual environment. - You can name the environment "dbtest" or choose any other name.
- If you choose a different name, make sure to add it to the
.gitignore
file.
- Use the
-
Database Authentication Setup
- Add the
mysql.auth
file to theapp/database/auth
directory for proper database connection and authentication.
- Add the
-
Run the Project
- Navigate to the
app/
directory and execute the following command to run the project:python main.py
- Navigate to the
-
Access Documentation
- After running the project, you can access the auto-generated API documentation at:
- (Swagger UI Docs)(localhost:8000/docs)
- (ReDoc UI Docs)(localhost:8000/redoc)
- Refer to the images in the
/발표자료
directory for examples of running features.
- After running the project, you can access the auto-generated API documentation at:
You can watch the demo video located in the /발표자료
directory.
Below are some screenshots of the key features: