https://github.com/rrgks6221/barogo-dev-task

barogo-dev-task
https://github.com/rrgks6221/barogo-dev-task

Last synced: 19 days ago
JSON representation

barogo-dev-task

• Host: GitHub
• URL: https://github.com/rrgks6221/barogo-dev-task
• Owner: rrgks6221
• Created: 2023-09-27T07:14:55.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-10-03T21:37:45.000Z (over 1 year ago)
• Last Synced: 2024-04-24T12:02:29.439Z (9 months ago)
• Language: JavaScript
• Size: 395 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# barogo dev task

## 개요

자판기 구현

## Documents

- [사용자 관점 플로우](./DOCUMENTS/MECHANISM.png)

- [개발 진행 전 요구사항 정의](./DOCUMENTS/REQUIREMENTS_DEFINITION.md)

- 간단한 api spec

  - 각 router index.js 에 주석으로 표현

  - [example](./src/routes/beverages/index.js)

## Usage

### Server Starting

```bash

$ git clone https://github.com/rrgks6221/barogo-dev-task

$ echo "PORT=3000" > .env

$ npm i

# 서버 시작 후 localhost:3000 접속하면 화면이 나옵니다.

$ npm run start

```

### Script

```bash

# server start

$ npm run start

# server start dev

$ npm run start:dev

# unit test

$ npm run test

# e2e test

$ npm run test:e2e

# api skeleton code generator (controller, service)

$ npm run g:res -- -p "example"

```

## Directory Structure

```bash

.

├── DOCUMENTS # document directory

├── scripts # script directory

├── src

│   ├── app.js # server config file

│   ├── bin

│   │   └── www.js # server starting file

│   ├── client # client code directory

│   │   ├── static # static directory

│   │   │   └── js

│   │   │       ├── functions.js

│   │   │       └── root.js

│   │   └── views # view directory

│   │       ├── index.js

│   │       └── root.ejs

│   ├── common # common function directory

│   ├── constants # constant directory

│   ├── entities # entity directory

│   ├── exceptions # exception directory

│   ├── middleware # middleware directory

│   │   ├── exception-filters # exception filter directory

│   │   └── pipes # pipe directory

│   ├── repositories # repository directory

│   ├── routes # router directory

│   └── services # service directory

└── test # e2e test directory

```

## Branch Strategy

| Icon                                                      | Label    | Description                          |

| --------------------------------------------------------- | -------- | ------------------------------------ |

|    | bugfix   | 버그 수정                            |

|    | delete   | 코드 삭제                            |

|       | doc      | 문서 작업                            |

|      | feat     | 새로운 기능 추가                     |

|    | modify   | 코드 수정(기능상의 수정이 있는 경우) |

|  | refactor | 코드 수정(기능상의 수정이 없는 경우) |

|      | test     | 테스트코드 관련 작업                 |

1. 먼저 이슈를 생성한다.

   1. 생성된 이슈번호와 branch type을 통해 브랜치를 생성한다.

      - {branch-type}/i{issue-number}/{branch-title}

        ex) `doc/i1/readme`

1. 작업이 완료되면 작업 브랜치에 푸시 후 `main` 브랜치에 PR 을 요청한다.

## Commit Strategy

| type     | Description                          |

| -------- | ------------------------------------ |

| bugfix   | 버그 수정                            |

| delete   | 코드 삭제                            |

| doc      | 문서 작업                            |

| feat     | 새로운 기능 추가                     |

| modify   | 코드 수정(기능상의 수정이 있는 경우) |

| refactor | 코드 수정(기능상의 수정이 없는 경우) |

| test     | 테스트코드 관련 작업                 |

1. 작업 브랜치의 이슈번호와 commit type 을 통해 커밋메시지를 작성한다.

   - [#{issue-number}]/{commit-type}: {commit description}

     ex) [#1]/{doc}: README.md