https://github.com/hanchiang/typescript-node-docker
A simple dockerised typescript koa server, ready to be developed and deployed
https://github.com/hanchiang/typescript-node-docker
docker docker-compose docker-multi-stage-build koajs mocha nodejs sinon typescript
Last synced: 3 months ago
JSON representation
A simple dockerised typescript koa server, ready to be developed and deployed
- Host: GitHub
- URL: https://github.com/hanchiang/typescript-node-docker
- Owner: hanchiang
- Created: 2019-12-01T02:33:23.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-24T00:51:17.000Z (over 3 years ago)
- Last Synced: 2023-03-06T01:08:51.126Z (over 3 years ago)
- Topics: docker, docker-compose, docker-multi-stage-build, koajs, mocha, nodejs, sinon, typescript
- Language: TypeScript
- Homepage:
- Size: 1.12 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Introduction
This is a typescript koa project with the following features:
* docker with multi stage build for development and production
* docker compose for development
* error handlers
* tests with mocha and sinon
* prettier
* eslint
# Setup
## Install required tools
* [docker setup](https://docs.docker.com/install/)
* [docker-compose setup](https://docs.docker.com/compose/install/)
## Clone project
* `git clone git@github.com:hanchiang/typescript-node-docker.git`
## Set up environment variables
`.env.dev`:
* `COOKIE_SECRET=mycookiesecret`
* `NODE_ENV=development`
# Using the project
**Run in development mode**
* Build: `docker-compose build`
* Start: `docker-compose up -d`
* Server is available at: `localhost:3000`
* Stop: `docker-compose down`
**Build production image**
* `npm run docker-build-prod`
# Note
Whenever new packages are added via `npm install`:
* You need to stop the service: `docker-compose stop ` or `docker-compose down`
* Build the service: `docker-compose build `
* Start the service: `docker-compose start ` or `docker-compose up -d`
# Reference
* Multi stage docker build - https://medium.com/@ankit.wal/the-why-and-how-of-multi-stage-docker-build-with-typescript-example-bcadbce2686c