Git Product home page Git Product logo

nodejs_typescript_example's Introduction

Project structure

danh

Description

Folder Description
.vscode .vscode directory contains settings for the visual code editor
dist/ the folder that has the output from the compiler
node_modules/ the folder containing the packages that the app and dev tools require
src/ the folder containing the source code files that will be compiled by the TypeScript compiler
test/ the folder containing all unit test for the source code
.env.example examples of environment variables used when running the project
.prettierrc, .eslintrc.js the configuration for the eslint tool
docker-compose.yml a fille containing the script to run project with docker, but I just write script to run mongodb because I have more time
jestconfig.json Jest's configuration can be defined in the jestconfig.json
package.json/ the folder containing the top-level package dependencies for a project
package_lock.json/ a file containing the complete list of package dependencies of a project
tsconfig.json, tsconfig.build.json a file having the config settings of the TypeScript compiler

Installation

Preparation

# create .env file and update the correct content
$ cp .env.example .env 

# run database
$ docker-compose up -d mongo

Compile the source code

$ npm run build

Running the app

# debug mode
$ npm run start:debug

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

Test

#  debug mode
$ npm run test:debug

Lint

# just checking
$ npm run lint

# check and auto fix
$ npm run lint:fix

nodejs_typescript_example's People

Contributors

dbg1995 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.