TizioFittizio / NodeTypescriptExpressTemplate

Boilerplate project typescript + node + express

NodeTypescriptExpressTemplate

Boilerplate project typescript + node + express

Included:

• Express
• Typescript with tslint already configured with sonarsource
• Test with mocha, expect and supertest
• Pre push hook with husky

Branch availables:

• mongo-starter

How to get it work

• Clone/Download this repository
• In the root folder, type in terminal npm install
• Followed by npm run type-start, this will run the typescript project
• You can use live-reload with nodemon with npm run watch
• In production, you may want to use npm start or npm run start , this will run the compiled javascript files in the dist folder
• To run the tests, use npm run test

Configuration

In order to work locally, you must provide a file config.json inside the config folder, like this:

{
    "test": {
        "PORT": 3000
    },
    "development": {
        "PORT": 3000
    }
}

When deployed, variable PORT should be provided from the server environment