Giter VIP home page Giter VIP logo

nodejs-typescript-template's Introduction

This project was created using themetalfleece/nodejs-typescript-template

What to do after using this template

  1. Edit package.json to set the project name, version, description, and author.
  2. Edit the LICENSE file to use your name in the Copyright section
  3. Delete this section from the README.md file

Install

  1. Install node.js, yarn.
  2. Clone this repository, and using a terminal navigate to its directory.
  3. Run yarn to install the dependencies.

Build & Run

  1. Copy the contents of the .env.example file to a .env next to it, and edit it with your values.
  2. Run yarn build to build the files.
  3. 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.

Linting & Formatting

  • Run yarn lint to lint the code.
  • Run yarn format to format the code.

nodejs-typescript-template's People

Contributors

themetalfleece avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.