Skip to content

DenoteMD/denote-md-backend

Repository files navigation

Denote MD back-end

Build status Vulnerabilities Closed Issues

Just a small piece for poor souls

Requirement

Make sure your Node.js is v10.23.0

Read this guideline before you begin Development Guideline

Installation

npm i --save-dev

This command will download all dependencies and development dependencies.

Configuration

You might need to copy example.env and rename them to .env and set necessary configuration.

Build

npm run build

To start development mode

npm run dev

This will start a development server, It will restart automatically if any TypeScript files in ./src/**/*.ts was changed.

To force nodemon restart, type rs then Enter

Before you commit your code

Please make sure you get no error from run this

npm run check

License

This software licensed under MIT License