bartkim-j / pretty-readme

for pretty readme

Pretty Read.Me

Getting Started

아래는 XX 프로젝트 를 실행하기 위한 가이드 입니다.

Prerequisites

---

아래 사항들이 설치 및 선행 되어 있어야 합니다.

• Docker Desktop (example)

  • Mac 설치

    $ (설치 명령어)
    

Installing

---

아래는 프로젝트를 설치하는 방법입니다.

1. 레포지토리 설치 (example)

   $ git clone https://github.com/BartKim-J/pretty-readme.git 
   $ cd pretty-readme
   

2. 환경 설치

   $ (환경설치 명령어)
   

Testing

하단의 스크립트를 실행하면 테스트 코드가 작동합니다.

$ (테스트 실행 구문)

아래와 같이 테스트가 진행됩니다.

(테스트 중)

(테스트 결과)

Running

아래는 프로젝트를 실질적으로 실행하는 방법에 대해 설명합니다.

Running Admin URL(http://127.0.0.1:8000)

• Django (example)

  $ python manage.py runserver
  

  (실행 결과)
  

• Gunicorn (example)

  $ gunicorn service.main:app
  

  ...
  (실행 결과)
  

Workflow

현재 Workflow 는 기본적으로 Git Flow 를 사용하고 있습니다.

• master : 제품으로 출시될 수 있는 브랜치
• develop : 다음 출시 버전을 개발하는 브랜치
• feature : 기능을 개발하는 브랜치
• release : 이번 출시 버전을 준비하는 브랜치
• hotfix : 출시 버전에서 발생한 버그를 수정 하는 브랜치
• fix : 기존에 발생한 버그를 수정하는 브랜치

Directory Structure(example)

.
├── app
│        ├── crud
│        ├── database
│        ├── grpc
│        │       ├── protos
│        │       └── protos_python
│        ├── middleware
│        ├── models
│        ├── routers
│        │       ├── health
│        │       ├── items
│        │       ├── sentry
│        │       └── users
│        ├── schemas
│        └── test
│            └── api
├── docker
│        ├── postgresql
│        └── redis
├── nginx
└── script
         └── grpc