Skip to content

Latest commit

 

History

History
49 lines (31 loc) · 1.45 KB

README.md

File metadata and controls

49 lines (31 loc) · 1.45 KB

DB-Project-Team-2

Initial Project Setup with FastAPI and SQLAlchemy


This project is a basic setup using FastAPI and SQLAlchemy.

Setup Instructions

  1. 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.
  2. Database Authentication Setup

    • Add the mysql.auth file to the app/database/auth directory for proper database connection and authentication.
  3. Run the Project

    • Navigate to the app/ directory and execute the following command to run the project:
      python main.py
  4. 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.

Demo Video

You can watch the demo video located in the /발표자료 directory.

Feature Screenshots

Below are some screenshots of the key features:

  • Login Feature

    로그인 기능

  • Sign-Up Feature

    회원가입 기능

  • Data Lookup Feature

    조회 기능