The following is the README file for the FastAPI Board Example project, which demonstrates how to build a web application using FastAPI and SQLAlchemy to create, read, update, and delete (CRUD) functionalities for a bulletin board.
This project provides an example implementation of a bulletin board with CRUD functionalities using FastAPI and SQLAlchemy to manage the database.
- Clone this repository.
git clone https://github.com/joon623/fastapi-board-example.git
- implement docker compose
docker compose up --build
- Clone this repository.
git clone https://github.com/joon623/fastapi-board-example.git
- Move into the cloned directory and create a virtual environment. Copy code
cd fastapi-board-example
python3 -m venv .venv
- Activate the virtual environment.
- Windows:
.venv\Scripts\activate
- macOS/Linux:
source .venv/bin/activate
- Install the necessary packages.
pip install -r requirements.txt
- Run the server.
uvicorn app.main:app --reload
- Access the API documentation using Swagger UI by navigating to http://localhost:8000/docs in a web browser.
- FastAPI
- SQLAlchemy
- Mysql
- Create, read, update, and delete posts
- User registration, login, and logout
For more detailed information, please refer to the README.md file in the repository.