1
0
mirror of https://github.com/byulmaru/quesdon synced 2024-11-27 14:28:04 +09:00
quesdon/README.md

33 lines
751 B
Markdown
Raw Normal View History

2017-12-09 09:39:59 +09:00
# quesdon
Mastodon/Misskey를 위한 ask.fm 같은거
2017-12-09 09:39:59 +09:00
LICENSE: [AGPL 3.0](LICENSE)
## how to run
2017-12-09 09:57:47 +09:00
required: latest version Node.js, MongoDB
2017-12-09 09:39:59 +09:00
```sh
2018-05-11 05:36:20 +09:00
yarn install
yarn build
MONGODB_URL=mongodb://localhost/quesdon BACK_PORT=3000 yarn start
2017-12-09 09:39:59 +09:00
```
2018-05-11 05:36:20 +09:00
## 개발
2018-05-11 05:36:20 +09:00
### 개발 환경 구축
2018-05-11 05:36:20 +09:00
`cp .env.development .env`한 뒤 `yarn dev`로 빌드 후 <http://localhost:8080> 로 접속
2018-05-11 05:36:20 +09:00
### 디렉터리 구조
2018-05-11 05:36:20 +09:00
굳이 안 적어놔도 보면 알겠지만 혹시 모르니까
2018-05-11 05:36:20 +09:00
- `src/`: 소스
- `server/`: 서버 사이드 소스
- `api/`: API 엔드포인트
- `db/`: 데이터베이스 모델
- `utils/`: 잡다한 것들
- `client/`: 클라이언트 소스
- `views/`: 서버 사이드 템플릿 (pug 템플릿 엔진 사용)