View Code? Open in Web Editor
NEW
This project forked from themetalfleece /nodejs-typescript-template
A template for a Node.js project using Typescript, ESLint, Prettier. Everything is configured with the appropriate scripts and README. An MIT license is set.
License: MIT License
nodejs-typescript-template's Introduction
What to do after using this template
Edit package.json
to set the project name, version, description, and author.
Edit the LICENSE
file to use your name in the Copyright section
Delete this section from the README.md
file
Install node.js , yarn .
Clone this repository, and using a terminal navigate to its directory.
Run yarn
to install the dependencies.
Copy the contents of the .env.example
file to a .env
next to it, and edit it with your values.
Run yarn build
to build the files.
Run yarn start
to start the application.
You can run yarn dev
to combine the 2 steps above, while listening to changes and restarting automatically.
You need to run yarn global add ts-node
once for this to run.
Run yarn lint
to lint the code.
Run yarn format
to format the code.
nodejs-typescript-template's People
Contributors