README 메뉴얼 - linewalks/dev-common GitHub Wiki

Project Title

TODO: Project Title을 실제 프로젝트 이름으로 변경합니다.

Description

TODO: 프로젝트에 대한 상세한 설명을 작성합니다.

사내 깃헙 프로젝트에서 일아나는 이벤트들을 웹훅을 통해서 구글 채팅봇에게 알림을 보내는 프로젝트입니다.

Getting Started

Built With

TODO: 프로젝트를 구성하는 주요 테크 스텍과 버젼들을 작성합니다.

  • Python 3.x
  • Flask 1.x
  • Node.js >= 10.16
  • yarn

Prerequisites

TODO: 프로젝트 설치를 위한 전제 과정들을 작성합니다.

  1. Node.js 설치(>= 10.16)
  • 파일다운로드 - OS에 맞는 파일을 다운 받아서 설치하는 방법
  • nvm - Node.js의 버전 매니저 이다. 이것을 사용하는것을 추천. 사용법은 문서 참고
  1. Yarn 설치
  • yarn - 프로젝트에 필요한 패키지를 설치 하도록 돕는 패키지 매니저이다.

Installation

TODO: 프로젝트를 설치하는 과정들을 작성합니다.

  1. Clone the repo. 
    > git clone https://github.com/linewalks/Project-Name.git
  2. Install NPM packages. 
    > npm install
  3. Enter your API in config.js. 
    const API_KEY = 'ENTER YOUR API';

Usage

TODO: 실행 방법 및 사용 방법에 대한 설명을 작성합니다.

> python run.py 5000

Custom Section(Optional)

TODO: 프로젝트 관련되어 추가되는 섹션. ex) Test

Links

TODO: 프로젝트 관련된 자료들의 링크를 추가합니다.

Contact

TODO: 프로젝트 관리자의 이름과 이메일을 입력합니다.