README.md

khuthon-backend

본 레포지토리는 경희대학교 중앙 IT 동아리 쿠러그에서 주관하는 해커톤 대회인 khuthon의 프론트엔드입니다.

Prerequisite

• Node.js v20.11.1

Installation

git clone https://github.com/khu-khlug/khuthon-backend.git
npm install

Run

npm run dev

공지 관리

khuthon의 공지글은 /notices 디렉토리 하위에서 모두 관리됩니다.

/notices
- _list.json      : 공지 목록 및 순서를 결정하는 메타데이터가 저장된 파일
- [noticeId]      : 각 공지의 데이터가 들어있는 디렉토리
  - metadata.json : 각 공지의 메타데이터가 저장된 파일
  - content.md    : 공지의 실제 내용

Caution

/notices 하위에 있는 모든 *.json 파일은 스크립트를 통해 관리됩니다. 따라서 특별한 경우를 제외하고는 절대 직접 수정하지 마세요. 특히, id 값은 어떠한 경우에라도 직접 수정하지 마세요.

새 공지 생성

npm run create-notice <공지 식별자> <공지 제목>

• <공지 식별자>: 각 공지를 유일하게 식별할 수 있는 문자열입니다. 영어 소문자, 숫자, 하이픈(-)만 사용할 수 있으며, 3자 이상 100자 이하여야 합니다.
• <공지 제목>: 공지의 제목입니다. 3자 이상 100자 이하여야 합니다.

새 공지를 생성합니다. 아래와 같이 사용할 수 있습니다.

npm run create-notice hello-world "안녕, khuthon!"

공지 제거

npm run delete-notice <공지 식별자>

• <공지 식별자>: 삭제할 공지의 식별자를 입력합니다.

기존 공지를 제거합니다. 공지를 제거할 때는 파일로 직접 제거하지 마시고, 해당 명령어를 사용해서 제거해주세요.

License

MIT License