README.md

tsed-rest

About the project

This is a template, copy, use and change the description here to the information about the project.

This exemple is ready to use, call the endpoint!!

Build setup

Important! Ts.ED requires Node >= 10, Express >= 4 and TypeScript >= 3.

# install dependencies
$ npm install

# serve
$ npm run start

# build for production
$ npm run build
$ npm run start:prod

Project structure

The project code base is mainly located within the src folder. This folder is divided in:

.
├── src
│   ├── config                            # Config of the whole project
│   │   ├── env
│   │   │   ├── index.ts                  # The config of all properties should be here
│   │   ├── logger
│   │   │   ├── index.ts                  # Log conf. you can do some small changes in order to setup the log
│   │   ├── typeorm
│   │   │   ├── default.config.json       # The database specification is in this file
│   ├── controllers                       # Endpoitns are here
└───└── services                          # To call a service, add here the code

3rd party libraries

• Ts.ED - Ts.ED is the framework used here.