Skip to content

fvsystem/node-typescript-template

Repository files navigation

ABOUT

This is a template for applications that use Node 16 with Typescript. This template has eslint configured, tests with Jest, lint commit (using conventional commits) and docker configuration for production an dev environment.

USING

To use this template, press the "Use Template" button on first page of this repository on Github, this will create a repository on your Github account, from which you can execute git clone command.

If you have docker installed on your machine, you can run the development environment by executing the following command:

docker compose up --build -d

docker-compose exec node bash

This docker configuration is not ready to expose ports, please, check docker documentation in case you need to expose ports.

VSCODE AND REMOTE DEVELOPMENT

You can use the Remote Development Extension from VSCode. You have to Run Command 'Dev Containers: Rebuild Container and Attach to Container' in VSCode command Pallet

With this environment, you will be inside the container configured, but you will also have access to your ssh keys and gpg keys in order to use git and remote repositories.

COMMITING

To commit on this repository, run the following command:

npm run commit

It will guide your through the conventional commit template. If you do not follow the conventional commit, a hook will prevent your commit to be completed.

About

template for new project node with typescript

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages