Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hmu332233/letmeknow.jbnu--management
알려줘전북대 관리자 페이지 및 api
https://github.com/hmu332233/letmeknow.jbnu--management
letmeknow-jbnu
Last synced: 4 days ago
JSON representation
알려줘전북대 관리자 페이지 및 api
- Host: GitHub
- URL: https://github.com/hmu332233/letmeknow.jbnu--management
- Owner: hmu332233
- License: mit
- Created: 2018-10-09T08:52:06.000Z (about 6 years ago)
- Default Branch: develop
- Last Pushed: 2022-12-22T11:21:34.000Z (almost 2 years ago)
- Last Synced: 2023-03-02T11:26:10.411Z (over 1 year ago)
- Topics: letmeknow-jbnu
- Language: JavaScript
- Homepage:
- Size: 7.34 MB
- Stars: 2
- Watchers: 2
- Forks: 3
- Open Issues: 44
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 알려줘전북대 관리자, api
[](https://travis-ci.org/hmu332233/LetMeKnow.jbnu--management)
알려줘전북대 관리자 페이지 및 api 서버입니다.
## Note
이 프로젝트는 [알려줘전북대](https://pf.kakao.com/_LffxoM)의 일부입니다.
프로젝트에 대해서는 [https://github.com/hmu332233/LetMeKnow.jbnu](https://github.com/hmu332233/LetMeKnow.jbnu)에서 확인해주세요.
## Requirements
- node8 이상
- mongodb 4.0 이상
- yarn (optional)
- git 2.13.0 이상 (optional)
## Getting Started
다음과 같은 순서로 api 서버를 실행할 수 있습니다.
1. 모듈 설치
```bash
$ yarn
```
2. .env 파일 복사
```bash
$ cp server/.env.example server/.env
```
3. .env 파일 내용 채워넣기
- api 서버 개발시에는 `MONGO_DB`, `NODE_ENV`만 있으면 됩니다.
```
NODE_ENV=development
MONGO_DB=mongodb://localhost:27017/db # 본인의 mongodb host를 적어주세요.
```
4. 서버 실행
```bash
$ yarn run start-server
```
## Testing
다음 명령어로 테스트가 가능합니다.
```bash
$ yarn test
```
[jest](https://jestjs.io/)를 사용하고 있으며,
jest의 사용방법은 해당 문서를 참고해주세요.
## Code Format
prettier가 git hooks를 통해 commit 단계에서 실행됩니다.
단, 이 기능은 git `2.13.0` 이상이여야합니다.
## Contribution
- 누구든지 이 프로젝트에 참여할 수 있습니다.
- 알려줘전북대에 대한 이슈는 [LetMeKnow.jbnu--ChatBot--/issues](https://github.com/hmu332233/LetMeKnow.jbnu--ChatBot--/issues)에 남겨주세요.
- 작업 방식은 다음과 같습니다.
1. 원하는 issue에 작업을 진행하겠다는 의사를 표시합니다.
2. 해당 repo를 fork하고 작업을 진행합니다.
3. 작업이 완료되었으면 `develop` 브랜치를 base로 pull request를 보내주세요.
- 자세한 사항은 [CONTRIBUTION.md](CONTRIBUTION.md)에서 확인해주세요.