A Simple boiler plate for developing RESTful api with express.js written in typescript. It includes standard middleware functions with default settings configured with express out of the box. It also includes a folder structure to help you get started with the project right away.
Download the project in to your computer from the releases section and extract the contents in a known location. To install the dependencies use
npm install
Edit the package.json to fit your project and start working.
-
helmet.
Secures the api by setting various http headers. Get more information at https://helmetjs.github.io/
-
body-parser.
Parses the request body from the incoming request. It's provided by express.js. Get more information at https://github.com/expressjs/body-parser
-
cors.
Used for setting up cross origin rules. It's also provided by express.js. Get more information at https://github.com/expressjs/cors
-
typeorm.
An ORM for Database operations. Get more information at https://typeorm.io/
-
class-validator.
Validator with typescript decorators. Get more information at https://github.com/typestack/class-validator
-
jsonwebtoken.
For Usage of JWT in the project. Get more information at https://github.com/auth0/node-jsonwebtoken
-
jwk-to-pem.
Convert a json web key to a PEM for use by OpenSSL or crytpo. Get more information at https://github.com/Brightspace/node-jwk-to-pem
-
bcrypt.
For hashing passwords. Get more information at https://github.com/kelektiv/node.bcrypt.js
-
dotenv For storing environment variables. Get more information at https://github.com/motdotla/dotenv#readme
-
Mocha
Test framework. Get more information at https://mochajs.org/
-
Chai
Assertion tool used in combination with mocha. Get more information at https://www.chaijs.com/
-
ts-node
Runs the project directly in typescript. Get more information at https://github.com/TypeStrong/ts-node
-
Debugger
Pre configured debug configuration for VScode editor.