README.md

template-docker-full-stack-app

Template Nginx, Node.js Express API, Vue.js Application

• getting started
  • cloning and setup
  • development startup
  • api testing
  • starting for production
• auxiliary
• CHANGELOG

---

getting started

the following applications are required to run in production:

• Docker (recommended: v19.03.2)
• Docker Compose (recommended: v1.24.1)

the following applications are required to run in development:

• Git (recommended: >= v2.21.0)
• Docker (recommended: v19.03.2)
• Docker Compose (recommended: v1.24.1)
• Node.js (recommended: v12.18.3)
• PM2 (recommended: v4.4.0)

cloning and setup

Note: need help with submodules? check this out

# clone full-stack template
git clone --recursive git@github.com:mi-sec/template-docker-full-stack-app.git
cd template-docker-full-stack-app/

development startup

./start.dev.sh

development startup with ui hot reloading

./start.dev.sh

# wait for the UI to finish building in docker-compose startup then:
cd app/ui
npm i
npm run serve
# access live ui at http://localhost:8080/

api testing

cd api
npm i
npm test

starting for production

./start.prod.sh

ui will be accessible at http://localhost by default api will be accessible at http://localhost/api/ by default

auxiliary

API testing:

For testing API things, import the Postman collection in the api folder. Environment should be set for:

• PROTOCOL: http
• HOSTNAME: localhost
• PORT: 80
• PATH: /api

CHANGELOG

v1.0.0

• initial release