Typescript RESTful Server Backend

The main purpose of this repository is to show a working Node.js API Server and workflow for writing Node code in TypeScript.

It is not a goal to be a comprehensive and definitive guide to making a TypeScript and Node project, but as a working reference maintained by the community. If you are interested in starting a new TypeScript project - check out the bootstrapping tools reference in the TypeScript Website

Table of contents:

• Pre-reqs
• Getting started

Pre-reqs

To build and run this app locally you will need a few things:

• Install Node.js
• Install Sequelize
• Install VS Code

Getting started

• Clone the repository

git clone --depth=1 https://github.com/arkenSt0ne/web-server-backend.git <project-name>

• Install dependencies

cd <project_name>
npm install

• To run the project in localhost

npm run localhost

• To list the logs using pino-pretty

tail -f -n 10 <project-working-dir>/logs/log.log | pino-pretty

Note on editors! - TypeScript has great support in every editor, but this project has been pre-configured for use with VS Code. Throughout the README We will try to call out specific places where VS Code really shines or where this project has been set up to take advantage of specific features.

Finally, The backend-server is hosted at http://localhost:8080