README.md

- 깃허브 연동을 통해 기술 블로그, README 등의 문서화 작업을 효율적으로 도와주는 서비스입니다. -

📝 Table of Contents

• Medium
• Demo
  
• System Architechture
  
• Tech stack
  
• ERD
  
• API
  
• Monitoring
  
• How to Start
  
• File Directory
  
• Member
  

📒 Medium

🔗 https://medium.com/@woal9844/siliconvalley-winter-bootcamp-gitodoc-korean-e35907b4b030

📹 Demo

메인페이지

마이독스

마이독스 - 생성

마이독스 - 검색

뷰어

뷰어 - 에디터

뷰어 - 공유

💻 System Architechture

💡 Tech stack

분야	사용 기술
Fronted
Backend
DevOps
Monitoring
etc

💾 ERD

📚 API

swagger

📈 Monitoring

Grafana & Prometheus

🚀 How to Start

1. clone the repository(docker-GCP)

git clone https://github.com/2023WB-TeamB/Docker-GCP.git

2. Set environment file

Path : Docker-GCP/backend/.env

SECRET_KEY=''

DATABASE_ENGINE=
DATABASE_NAME=''
DATABASE_USER=''
DATABASE_PASSWORD=''
DATABASE_HOST=
DATABASE_PORT=
DATABASE_OPTIONS=init_command=''

GPT_SECRET_KEY=''

ENG_TITLE_ASSISTANT_ID=''
KOR_TITLE_ASSISTANT_ID=''

ENG_OUTLINE_ASSISTANT_ID=''
KOR_OUTLINE_ASSISTANT_ID=''

ENG_CODE_ASSISTANT_ID=''
KOR_CODE_ASSISTANT_ID=''

ENG_TECH_STACK_ASSISTANT_ID=''
KOR_TECH_STACK_ASSISTANT_ID=''

ENG_MAIN_FUNCTION_ASSISTANT_ID=''
KOR_MAIN_FUNCTION_ASSISTANT_ID=''

ENG_CORE_ALGORITHM_ASSISTANT_ID=''
KOR_CORE_ALGORITHM_ASSISTANT_ID=''


FRAMEWORK_ASSISTANT_ID=''

GITHUB_TOKEN=''

RABBITMQ_DEFAULT_USER=
RABBITMQ_DEFAULT_PASS=
RABBITMQ_BROKER=''

AWS_ACCESS_KEY_ID=''
AWS_SECRET_ACCESS_KEY=''

3. Set ceritificate.pem , priviate.key

Path : Docker-GCP/nginx/ceritificate.pem

-----BEGIN CERTIFICATE-----

-----END CERTIFICATE-----

Path : Docker-GCP/nginx/priviate.key

-----BEGIN RSA PRIVATE KEY-----

-----END RSA PRIVATE KEY-----

4. run

docker-compose -f docker-compose.prod.yml up --build

📁 File Directory

Click

  📦Docker-GCP
   ┣ 📂.github
   ┃ ┗ 📂workflows
   ┃   ┗ 📜docker-image.yml
   ┣ 📂backend
   ┃ ┣ 📂.github
   ┃ ┃ ┣ 📂ISSUE_TEMPLATE
   ┃ ┃ ┗ 📂workflows
   ┃ ┃   ┗ 📜django_deploy.yml
   ┃ ┣ 📂badge
   ┃ ┃ ┣ 📜__init__.py
   ┃ ┃ ┣ 📜admin.py
   ┃ ┃ ┣ 📜apps.py
   ┃ ┃ ┣ 📜models.py
   ┃ ┃ ┣ 📜tech_stack_images.py
   ┃ ┃ ┣ 📜tests.py
   ┃ ┃ ┣ 📜urls.py
   ┃ ┃ ┗ 📜views.py
   ┃ ┣ 📂docs
   ┃ ┃ ┣ 📜__init__.py
   ┃ ┃ ┣ 📜admin.py
   ┃ ┃ ┣ 📜AiTask.py
   ┃ ┃ ┣ 📜apps.py
   ┃ ┃ ┣ 📜github.py
   ┃ ┃ ┣ 📜models.py
   ┃ ┃ ┣ 📜serializers.py
   ┃ ┃ ┣ 📜tests.py
   ┃ ┃ ┣ 📜urls.py
   ┃ ┃ ┗ 📜views.py
   ┃ ┣ 📂gtd
   ┃ ┃ ┣ 📜__init__.py
   ┃ ┃ ┣ 📜asgi.py
   ┃ ┃ ┣ 📜celery.py
   ┃ ┃ ┣ 📜settings.py
   ┃ ┃ ┣ 📜urls.py
   ┃ ┃ ┗ 📜wisgi.py  
   ┃ ┣ 📂templates
   ┃ ┃ ┗ 📂tag
   ┃ ┃   ┣ 📜card1.html
   ┃ ┃   ┣ 📜terminal1.html
   ┃ ┃   ┗ 📜terminal2.html
   ┃ ┗ 📂users
   ┃ ┃ ┣ 📜__init__.py
   ┃ ┃ ┣ 📜admin.py
   ┃ ┃ ┣ 📜apps.py
   ┃ ┃ ┣ 📜models.py
   ┃ ┃ ┣ 📜serializers.py
   ┃ ┃ ┣ 📜tests.py
   ┃ ┃ ┣ 📜urls.py
   ┃ ┃ ┣ 📜utils.py 
   ┃ ┃ ┗ 📜views.py
   ┃ ┣ 📜.gitignore
   ┃ ┣ 🐳docker-compose.dev.yml
   ┃ ┣ 🐳Dockerfile
   ┃ ┣ 📜manage.py
   ┃ ┣ 📜prometheus.yml
   ┃ ┣ 📜README.md
   ┃ ┗ 📜requirements.txt
   ┣ 📂frontend
   ┃ ┣ 📂.github
   ┃ ┃ ┗ 📂ISSUE_TEMPLATE
   ┃ ┣ 📂public
   ┃ ┃ ┗ 📜gtd.svg
   ┃ ┣ 📂src
   ┃ ┃ ┣ 📂assets
   ┃ ┃ ┃ ┣ 📂fonts
   ┃ ┃ ┃ ┗ 📂images
   ┃ ┃ ┃   ┣ 📂MainPage
   ┃ ┃ ┃   ┣ 📂mydocs
   ┃ ┃ ┃   ┗ 📂Viewer
   ┃ ┃ ┃     ┗ 📂Badge
   ┃ ┃ ┣ 📂components
   ┃ ┃ ┃ ┣ 📂MainPage
   ┃ ┃ ┃ ┣ 📂mydocs
   ┃ ┃ ┃ ┃ ┣ 📂lower  
   ┃ ┃ ┃ ┃ ┗ 📂upper 
   ┃ ┃ ┃ ┣ 📂ViewEdit
   ┃ ┃ ┃ ┣ 📜BadgeGuide.tsx
   ┃ ┃ ┃ ┣ 📜CloseBtn.tsx
   ┃ ┃ ┃ ┣ 📜GradientBtn.tsx
   ┃ ┃ ┃ ┣ 📜Header.tsx
   ┃ ┃ ┃ ┣ 📜ModalStore.tsx
   ┃ ┃ ┃ ┣ 📜Register.tsx
   ┃ ┃ ┃ ┣ 📜SearchItem.tsx
   ┃ ┃ ┃ ┣ 📜SearchList.tsx
   ┃ ┃ ┃ ┣ 📜Signin.tsx
   ┃ ┃ ┃ ┣ 📜useDebounce.tsx
   ┃ ┃ ┃ ┗ 📜useOutsideClick.tsx
   ┃ ┃ ┣ 📂pages
   ┃ ┃ ┃ ┣ 📜MainPage.tsx  
   ┃ ┃ ┃ ┣ 📜MyDocsPage.tsx  
   ┃ ┃ ┃ ┣ 📜SharedDocPage.tsx  
   ┃ ┃ ┃ ┗ 📜ViewerPage.tsx  
   ┃ ┃ ┣ 📂store
   ┃ ┃ ┃ ┗ 📜store.ts 
   ┃ ┃ ┣ 📜App.css
   ┃ ┃ ┣ 📜App.tsx
   ┃ ┃ ┣ 📜GlobalStyle.tsx
   ┃ ┃ ┣ 📜index.css
   ┃ ┃ ┣ 📜main.tsx
   ┃ ┃ ┗ 📜vite-env.d.ts
   ┃ ┣ 📜.eslintrc.cjs
   ┃ ┣ 📜.gitnore
   ┃ ┣ 📜.prettierrc
   ┃ ┣ 🐳docker-compose.dev.yml
   ┃ ┣ 🐳Dockerfile
   ┃ ┣ 📜Dockerfile.prod
   ┃ ┣ 📜index.html
   ┃ ┣ 📜package.json
   ┃ ┣ 📜README.md
   ┃ ┣ 📜tsconfig.json
   ┃ ┣ 📜tsconfig.node.json
   ┃ ┣ 📜vite.config.ts
   ┃ ┣ 📜yarn.lock
   ┣ 📂nginx
   ┃ ┣ 🐳Dockerfile
   ┃ ┗ 📜nginx.conf
   ┣ 📂prometheus
   ┃ ┗ 📜prometheus.yml
   ┣ 📜.gitmodules
   ┣ 🐳docker-compose.prod.yml
   ┗ 📜README.md

😃 Member

Name	김선재	고재훈	김광현	나희수	오채영	김동현	장태희	홍선아
Profile
role	Leader Backend DevOps	Frontend	Frontend	Frontend	Frontend	Backend	Backend DevOps	Backend
GitHub	@sunjae98	@hoon99	@Haron1248	@naGGuri	@ocy5007	@ddhhy	@TaeHee00	@HongSeonah