Skip to content
This repository has been archived by the owner on Apr 30, 2021. It is now read-only.

Latest commit

 

History

History
41 lines (34 loc) · 1.14 KB

README.md

File metadata and controls

41 lines (34 loc) · 1.14 KB

Express Starter Kit

Express + WebPack + Babel + Docker starter kit

Local Development

Prerequisites

Useful Aliases

Add these aliases to your ~/.bash_profile for faster development

alias npx="docker run -it --rm -v \$(pwd):/app skypress/npx npx"
alias yarn="docker run -it --rm -v \$(pwd):/app skypress/npx yarn"

Remember to source the file after adding the aliases: source ~/.bash_profile

Makefile

  • make: Default command will run the linter and tests
  • make lint: Run the linter
  • make test: Run all tests
  • make build: Manually run the webpack build
  • make debug: Start a node debug session
  • make start: Start the local development environment
  • make setup: Create a docker network and install all node_modules

Initial Setup

  • Setup the project
make setup
  • Create a .env file using this template:
APP_NAME=express-start
NODE_ENV=development
HOST=kit-server
PORT=3000

Documentation

Documentation is generated using the jsdoc module. Use this cheatsheet as a quick reference.