Skip to content

Latest commit

 

History

History
114 lines (87 loc) · 4.31 KB

README.md

File metadata and controls

114 lines (87 loc) · 4.31 KB

Logo

🧇 Waffle mate 🧇

//    일정&일기 공유를 통한 효과적인 일정관리를 경험하세요    //

Waffle mate REST API Server

본 프로젝트는 todo mate 애플리케이션의 클론 코딩입니다.
주요 기능으로는 일정 관리와 일기 작성 등이 있으며,
다른 사람을 팔로우하고 댓글을 작성하는 등 다른 유저와의 소통 또한 가능합니다.

⚒️ Software Stack ⚒️

< Requirements & Environments >





Platfrom : Linux/UNIX (AWS Linux 2 Free-tier)
Database : AWS RDS / MySQL / db.t3.micro


🚀 Installation

/ git clone /
$ git clone --branch develop https://github.com/wafflestudio20-5/team6-server.git

/ install requirements /
$ pip install -r requirements.txt

/ migration /
$ python manage.py makemigrations
$ python manage.py migrate

/ runserver /
$ python manage.py runserver ...

🔥 Details

1. Diary

  • 날짜 / 유저 별로 일기 CRUD
  • 일기 조회에 follow authorization 설정
  • 각 일기에 댓글 달기 가능

2. Task

  • 날짜 / 유저 별로 할 일 CRUD
  • 성취 여부 / 미루기 기능 추가

3. Search & Follow

  • 이메일을 통해 유저 검색 가능
  • 팔로우 / 차단 기능 추가

4. Comment

  • 일기에 댓글 CRUD
  • 댓글을 달 때 follow authorization 설정

5. Account

  • 유저 정보 CRUD
  • 회원가입 / 로그인 / 소셜 로그인 (구글 & 카카오)
  • 소셜 계정 연동
  • 인증번호 재전송 및 부가기능


✔️ Note

  • 본 프로젝트는 Django REST framework을 기반한 REST API 서버로, 별도의 프론트엔드 클라이언트가 필요합니다.
  • 구글과 카카오톡 로그인을 지원하며, 이를 위해서는 구글 클라우드 플랫폼과 카카오 Developers에서 자신의 프로젝트를 따로 등록해야 합니다.
  • 데이터베이스로는 MySQL을 사용하고 있습니다.
  • 서버는 Amazon EC2/Gunicorn/NGINX를 통해 호스팅하고 있습니다.
  • Amazon S3을 사용하여 이미지를 관리하기 위해서는 별도의 설정이 필요합니다.

✨ Contributing

Pull Request는 언제나 환영입니다!
서비스 개선점이나 버그는 Issue를 자유롭게 이용해 주세요!

😊 Contributors


📄 License

MIT License