qdm12 / node-ts-template

NodeJS with Typescript template

REPONAME_GITHUB

SHORT_DESCRIPTION

Features

• Compatible with amd64, 386, arm64, arm32v7, arm32v6, ppc64le and s390x CPU architectures.
• Docker image tags and sizes

Setup

1. Use the following command:

   docker run -d qmcgaw/REPONAME_DOCKER

   You can also use docker-compose.yml with:

   docker-compose up -d

2. You can update the image with docker pull qmcgaw/REPONAME_DOCKER:latest or use one of tags available

Environment variables

Environment variable	Default	Possible values	Description

Development

1. Setup your environment

   Using VSCode and Docker

   1. Install Docker
      • On Windows, share a drive with Docker Desktop and have the project on that partition
      • On OSX, share your project directory with Docker Desktop
   2. With Visual Studio Code, install the remote containers extension
   3. In Visual Studio Code, press on F1 and select Remote-Containers: Open Folder in Container...
   4. Your dev environment is ready to go!... and it's running in a container 👍

   Locally

   Install Nodejs and Docker, with eventually yarn

2. Commands available:

   # Starts the development server with ts-node
   yarn start
   # Test the code
   yarn test
   # Lint the code
   yarn lint
   # Build the app for production
   yarn build
   # Build the Docker image
   docker build -t qmcgaw/REPONAME_DOCKER .

3. See Contributing for more information on how to contribute to this repository.

TODOs

• Change public icons and logos
• Write some dummy tests

License

This repository is under an MIT license unless otherwise indicated