Skip to content

2023년 겨울방학 부트캠프 프로젝트 - 북그북그

Notifications You must be signed in to change notification settings

2023-Winter-Bootcamp-Team-I/backend

Repository files navigation

메인화면

image

📒 Medium

✍️ Bookg-Bookg

📹 Demo

📝 메인

메인

📝 초기 정보 입력

초기 정보 입력

📝 이야기 선택

이야기 선택

📝 제목 입력

제목 입력

📝 책 생성 된 메인

책 생성 된 메인

📝 생성 된 책 조회

생성 된 책 조회 생성 된 책 조회 2

📝 한/영 전환

한/영 전환

📝 이메일 공유

이메일 공유 이메일 공유 2

💻 System Architechture

system architecture

🛠️ Tech stack

✔️ The reason for selecting these tech stacks

분야 사용 기술
Fronted
Backend
DevOps
Monitoring
etc Slack Notion Figma

🗂️ ERD

 ERD

📚 API

swagger
bookg-bookg API

📈 Monitoring

Grafana & Prometheus

Django

🏃‍♀️ How to Start

Clone Repository

$ git clone --recursive https://github.com/A-Interview/Docker.git <- 우리꺼로 해야함

secrets.json setting in the backend folder

  • backend/secrets.json
# backend env
"DJANGO_SECRET_KEY" :

# AWS env
"ACCESS_KEY_ID":
"SECRET_ACCESS_KEY":
"AWS_BUCKET_NAME":
"FILE_URL":

# GPT & DALL-E
"GPT_MODEL":
"DALL_E_MODEL":
"GPT_KEY":

# Naver
"YOUR_NAVER_USER_EMAIL":
"YOUR_NAVER_PWD":
"NAVER_CLIENT_ID":
"NAVER_CLIENT_SECRET":

#DB
"MYSQL_NAME":
"MYSQL_USER":
"MYSQL_PASSWORD":
"MYSQL_HOST":
"MYSQL_PORT":

Run Docker

/Docker/backend
$docker compose up --build

/Docker/frontend
$npm run dev

📂 Directory Structure

Open

📦backend
 ┣ 📂backend
 ┃ ┣ 📜__init__.py
 ┃ ┣ 📜asgi.py
 ┃ ┣ 📜celery.py
 ┃ ┣ 📜settings.py
 ┃ ┣ 📜urls.py
 ┃ ┗ 📜wsgi.py
 ┣ 📂book
 ┃ ┣ 📜__init__.py
 ┃ ┣ 📜admin.py
 ┃ ┣ 📜apps.py
 ┃ ┣ 📜models.py
 ┃ ┣ 📜routing.py
 ┃ ┣ 📜serializers.py
 ┃ ┣ 📜tasks.py
 ┃ ┣ 📜tests.py
 ┃ ┣ 📜urls.py
 ┃ ┣ 📜views.py
 ┃ ┗ 📜write_page.py
 ┣ 📂page
 ┃ ┣ 📂migrations
 ┃ ┣ 📜__init__.py
 ┃ ┣ 📜admin.py
 ┃ ┣ 📜apps.py
 ┃ ┣ 📜models.py
 ┃ ┣ 📜tests.py
 ┃ ┗ 📜views.py
 ┣ 📂user
 ┃ ┣ 📂migrations
 ┃ ┣ 📜__init__.py
 ┃ ┣ 📜admin.py
 ┃ ┣ 📜apps.py
 ┃ ┣ 📜models.py
 ┃ ┣ 📜serializers.py
 ┃ ┣ 📜tests.py
 ┃ ┣ 📜urls.py
 ┃ ┗ 📜views.py
 ┣ 📂grafana
 ┣ 📂myenv
 ┣ 📂prometheus
 ┣ 📜Dockerfile
 ┣ 📜celerybeat-schedule.db
 ┣ 📜db.sqlite3
 ┣ 📜docker-compose.yml
 ┣ 📜manage.py
 ┗ 📜requirements.txt
📦frontend
 ┃ ┣ 📂ws
 ┃ ┃ ┣ 📂lib
 ┃ ┃ ┃ ┣ 📜websocket-server.js
 ┃ ┃ ┃ ┗ 📜websocket.js
 ┃ ┣ 📂assets
 ┃ ┣ 📂components
 ┃ ┃ ┣ 📜BackgroundTemplate.tsx
 ┃ ┃ ┣ 📜ContentPage.tsx
 ┃ ┃ ┣ 📜CreateTitleModal.tsx
 ┃ ┃ ┣ 📜FrontCover.tsx
 ┃ ┃ ┣ 📜LogInModal.tsx
 ┃ ┃ ┣ 📜NavBar.tsx
 ┃ ┃ ┗ 📜ShareModal.tsx
 ┃ ┣ 📂pages
 ┃ ┃ ┣ 📜AboutUsPage.tsx
 ┃ ┃ ┣ 📜BackCoverPage.tsx
 ┃ ┃ ┣ 📜BookGuidePage.tsx
 ┃ ┃ ┣ 📜CreateBookPage.tsx
 ┃ ┃ ┣ 📜CreateInfoPage.tsx
 ┃ ┃ ┣ 📜CreationFinishPage.tsx
 ┃ ┃ ┣ 📜CreationStartPage.tsx
 ┃ ┃ ┣ 📜FrontCoverPage.tsx
 ┃ ┃ ┣ 📜HomePage.tsx
 ┃ ┃ ┣ 📜LibraryPage.tsx
 ┃ ┃ ┣ 📜LoadingPage.tsx
 ┃ ┃ ┣ 📜MainPage.tsx
 ┃ ┃ ┣ 📜ReadBookPage.tsx
 ┃ ┃ ┣ 📜ServicePage.tsx
 ┃ ┃ ┣ 📜SignUp.tsx
 ┃ ┃ ┣ 📜SliderPage.tsx
 ┃ ┃ ┗ 📜StoryChoiceModal.tsx
 ┃ ┣ 📂states
 ┃ ┃ ┗ 📜atom.ts
 ┃ ┣ 📂utils
 ┗ ┃ ┗ 📜Routes.tsx
   ┗ 📂websocket
     ┗ 📜WebSocketProvider.tsx

👨‍👩‍👧‍👧 Member

Name 김민지 송유림 정세훈 윤영균 최성훈 김진용
Profile
role Team Leader
Backend
DevOps
Frontend Frontend Frontend Backend Backend
GitHub    alswl020208       youlimsongs       Jung-Se-Hoon       yyg47       EccentricNoah       kingjinyong   

About

2023년 겨울방학 부트캠프 프로젝트 - 북그북그

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •