README.md

VSIGN-API

A Node.js REST API for Vsign site

• Express (Routing middlewares, Web, Api),

• Typescript,

• Mongoose,

• SCSS,

• EJS,

• Nodemon,

• TSLint,

• TypeDoc,

• Bcrypt,

• Hapy/joi,

• Helmet

• Simple npm setup and maintenance, without grunt/gulp/webpack/...

• Support for async/await

install the repo dependencies with npm

npm install

start the server

npm run dev

Other commands

Run the linter manually:

npm run lint

Clean temp folders:

npm run clean

Run the tests:

npm test

Generate docs, the output will be in /doc folder:

npm run doc

Production / Integration

To run the project in a server you'll want to run the built code instead src version.

# deploy the repo to server and run
npm install
npm start

License

MIT