README.md

library-service-server-test

KUCC Library Service Server Test Repository

💻 Backend Developers

권민재	한수빈	박진권	안준현
mjkweon17	smreosms13	Supernova0417	DDididingding
Auth, Search, Users CI/CD	ORM, Admins, Schemas	ERD, Books, Users	ERD
API Documentation

If you would like to contribute to this project or if you have any questions or need assistance, feel free to reach out to mjkweon17 for guidance.

🛠 Tech Stack

Framework	FastAPI
Language	Python 3.10
Database/ORM	MySQL, Naver Cloud Platform - Cloud DB for MySQL, SQLAlchemy
CI/CD	Naver Cloud Platform - Server, Docker, Docker Hub, GitHub Actions
ETC	Swagger, Notion, Figma, Discord, ERDCloud, MySQL Workbench

Getting Started

To get started with this app, follow these steps:

1. Clone the repository:

   git clone https://github.com/kucc/library-service-server-test.git

2. Navigate to the project directory:

   cd library-service-server-test

3. Create and activate a virtual environment:

   cd app
   python -m venv venv
   .\venv\Scripts\activate  # On Windows
   source venv/bin/activate  # On macOS/Linux

4. Install dependencies:

   pip install -r requirements.txt

5. Run the app using the provided PowerShell script:

    ./run.ps1

Directory Structure

Here's a brief overview of the project structure:

• app: Contains the main FastAPI application code.
• run.ps1: PowerShell script to easily run the FastAPI app.
• requirements.txt: List of dependencies required for the app.
• ...

Usage

[Provide instructions on how to use your app, API endpoints, etc.]

License

This project is licensed under the MIT License.