Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fedeizzo/epoc
Eating Planner for Organized Creatures
https://github.com/fedeizzo/epoc
docker docker-compose foalts mongodb mongoose restapi typegoose typescript
Last synced: 4 days ago
JSON representation
Eating Planner for Organized Creatures
- Host: GitHub
- URL: https://github.com/fedeizzo/epoc
- Owner: fedeizzo
- Created: 2020-11-03T19:49:44.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2022-04-19T15:02:53.000Z (over 2 years ago)
- Last Synced: 2024-10-12T21:46:04.582Z (about 1 month ago)
- Topics: docker, docker-compose, foalts, mongodb, mongoose, restapi, typegoose, typescript
- Language: TypeScript
- Homepage:
- Size: 12.4 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](https://travis-ci.org/fedeizzo/EPOC)
# EPOC
## Table of contents
* [Initialize](#initialize)
* [Run](#run)
* [Develop](#develop)
* [Production](#production)
* [Tips](#tips)
* [Helpful commands](#helpful-commands)
* [Foal](#foal)
## Initialize
Development setup:
```bash=
npm i && npm i -D
npm i -g @foal/cli
docker-compose -f docker-compose.dev.yaml build
```
Production setup:
```bash=
docker build -f Dockerfile.production -t epoc/epoc:latest .
```
## Run
You can run _EPOC_ either in development or production mode, refer to the sections below for the one you want. If you want to run this project on your machine follow develop section below.
### Develop
In order to run _EPOC_ in development mode some steps are required:
1. set _SETTINGS_JWT_SECRET_OR_PUBLIC_KEY_ inside .env file
2. run `docker-compose -f docker-compose.dev.yaml -d up`
3. run `npm run develop`
### Production
In order to run _EPOC_ in production mode some steps are required:
1. set _SETTINGS_JWT_SECRET_OR_PUBLIC_KEY_ inside .env file
2. set _MONGODB_URI_ inside .env file
3. run `docker run --name epoc -d --rm epoc:latest`
### Tips
* There is a .env.sample for easy setup. Inside it is written the command that can be used in order to generate _SETTINGS_JWT_SECRET_OR_PUBLIC_KEY_
## Helpful commands
### Foal
```bash=
foal generate controller
```
```bash=
foal generate model
```
```bash=
foal generate hook
```
```bash=
foal generate service
```