selon-api

🐹루피와 친구들🐹의 프로젝트입니다

개발기간: 2024. 05. ~

🛠️참여자

minecoby

2-z-won

프로젝트 소개

selon-api는 사용자 관리 및 공지사항 관리 기능을 제공하는 API입니다. 이 프로젝트는 FastAPI 프레임워크를 기반으로 하며, 사용자 등록, 로그인, 공지사항 생성 및 조회 등의 기능을 포함하고 있습니다.

📦 기술 스택

Environment

Development

📂 아키텍쳐

디렉토리 구조

selon-api-main/
├── README.md
├── __pycache__/
├── database.py
├── github_pull.py
├── main.py
├── notices.py
├── requirements.txt
├── test.db
├── users.py
├── data/
│   ├── __pycache__/
│   ├── database.py
│   ├── models.py
│   ├── schema.py
├── router/
    ├── __pycache__/
    ├── __init__.py
    ├── board_router.py
    ├── crud.py
    ├── notices_router.py
    ├── users_router.py

파일 설명

• main.py: FastAPI 애플리케이션의 main코드입니다. 사용자 및 공지사항 라우터를 포함하고 있으며, CORS 설정이 포함되어 있습니다.
• database.py: 데이터베이스 설정 및 초기화를 담당합니다.
• github_pull.py: GitHub 웹훅을 처리하는 기능을 포함하고 있습니다.
• notices_router.py: 공지사항 관련 API를 정의하고 있습니다.
• users_router.py: 사용자 관련 API를 정의하고 있으며, 비밀번호 해시화 및 사용자 인증 기능을 포함하고 있습니다.
• board_router.py: 커뮤니티 게시판 관련 API를 정의하고 있습니다.
• requirements.txt: 프로젝트에 필요한 모든 버전을 관리합니다.

주요 기능

• 사용자 관리
  • 사용자 등록
  • 사용자 로그인
  • 사용자 정보 수정
    
    
• 공지사항 관리
  • 공지사항 생성
  • 공지사항 조회

설치 및 실행

1. 저장소를 클론합니다.

   git clone https://github.com/your-repo/selon-api-main.git
   cd selon-api-main

2. 필요한 패키지를 설치합니다.

   pip install -r requirements.txt

3. 애플리케이션을 실행합니다.

   uvicorn main:app --reload

4. 브라우저에서 다음 URL을 엽니다.

   http://localhost:8000/docs
   

사용 예시

• 사용자 등록

  POST /users/
  {
    "username": "example",
    "password": "password123"
  }

• 사용자 로그인

  POST /users/login
  {
    "username": "example",
    "password": "password123"
  }

기여 방법

1. 이 저장소를 포크합니다.
2. 새로운 브랜치를 만듭니다.

   git checkout -b feature-branch

3. 변경 사항을 커밋합니다.

   git commit -m "커밋 메시지 입력"

4. 브랜치에 푸시합니다.

   git push origin feature-branch

5. 풀 리퀘스트를 생성합니다.

---

이 프로젝트에 대한 기여는 언제나 환영합니다! 버그 신고, 기능 제안, 풀 리퀘스트 등을 통해 프로젝트를 개선하는데 참여해 주세요.