Skip to content

Latest commit

 

History

History
56 lines (49 loc) · 1.41 KB

README.md

File metadata and controls

56 lines (49 loc) · 1.41 KB
Raw

REST Container Template

Header Logo

Contents Overview

  • Loader
  • Express Routes : Controller + Middleware
  • Models
  • Services
  • Injector
  • EventEmitter
  • Sample Tests

Setup

If you are using gh (https://cli.github.com/) then you can simply do

gh repo create my-own-custom-repo --template="turbopasi/rest-container-template"

If you are using vanilla git then you should clone and re-initialize for a new repo

git clone https://github.com/turbopasi/rest-container-template my-own-custom-repo
cd my-own-custom-repo
rm -r .git
git init .

Environment Variables

For you to be able to create a MongoDB Cloud Connection, add you secret variables to a .env file in the root directory. See .env.example for an example.

#MONGODB
MONGODB_USERNAME=""
MONGODB_PASSWORD=""
MONGODB_DATABASENAME=""

Install & run for development

cd my-own-custom-repo
npm install 
npm run dev
npm test

Hygen generator included

I started to add convenient code generators using hygen

  • To add a new route to the express router run npm run add:route
  • To add a new subroute to the new route run npm run add:subroute
  • To add a new service run npm run add:service

Build Docker image & run container

docker build -t <your username>/rest-container-template .
docker run -p 20300/8080 -d <your username>/rest-container-template