Giter Club home page Giter Club logo

fastapi-board-practice's Introduction

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.

Overview

This project provides an example implementation of a bulletin board with CRUD functionalities using FastAPI and SQLAlchemy to manage the database.

Installation and Running with Docker

  1. Clone this repository.
git clone https://github.com/joon623/fastapi-board-example.git
  1. implement docker compose
docker compose up --build

Installation and Running

  1. Clone this repository.
git clone https://github.com/joon623/fastapi-board-example.git
  1. Move into the cloned directory and create a virtual environment. Copy code
cd fastapi-board-example
python3 -m venv .venv
  1. Activate the virtual environment.
  • Windows:
.venv\Scripts\activate
  • macOS/Linux:
source .venv/bin/activate
  1. Install the necessary packages.
pip install -r requirements.txt
  1. Run the server.
uvicorn app.main:app --reload
  1. Access the API documentation using Swagger UI by navigating to http://localhost:8000/docs in a web browser.

Technologies Used

  • FastAPI
  • SQLAlchemy
  • Mysql

Functionality

  • 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.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.