https://github.com/yeukfei02/lunchpickerapi
Lunch picker is the tool to help you to answer where should I have lunch
https://github.com/yeukfei02/lunchpickerapi
docker express hacktoberfest lunch lunch-picker mongodb mongoose nodejs typescript
Last synced: 7 months ago
JSON representation
Lunch picker is the tool to help you to answer where should I have lunch
- Host: GitHub
- URL: https://github.com/yeukfei02/lunchpickerapi
- Owner: yeukfei02
- License: mit
- Created: 2019-12-21T16:40:31.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-07-20T03:58:14.000Z (over 1 year ago)
- Last Synced: 2024-07-21T04:30:14.048Z (over 1 year ago)
- Topics: docker, express, hacktoberfest, lunch, lunch-picker, mongodb, mongoose, nodejs, typescript
- Language: TypeScript
- Homepage: https://www.lunch-picker-api.com/
- Size: 1.85 MB
- Stars: 9
- Watchers: 3
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
lunchPickerApi
If you’re a working software engineer, you’ve probably encountered with one of the toughest questions, where should I have lunch?
Lunch picker is the tool you’ll turn to to answer this question.
documentation:
api url:
react admin url:
```text
username: admin@admin.com
password: admin
```
## Requirement
- install yarn
- install node (v16)
- install mongodb
## Testing and run
```zsh
$ yarn
// development
$ yarn run dev
// production
$ yarn run start
// run test case
$ yarn run test
// lint code
$ yarn run lint
// format code
$ yarn run format
```
## Docker
```zsh
// build images and start container in one line
docker-compose up -d --build
// go inside container
docker exec -it /bin/bash
// check container logs
docker logs
// remove and stop container
docker-compose down
```
open localhost:3000
## Contributing
Please refer to [CONTRIBUTING.md](https://github.com/yeukfei02/lunchPickerApi/blob/master/CONTRIBUTING.md)