Skip to content

Latest commit

 

History

History
68 lines (45 loc) · 2.9 KB

README.md

File metadata and controls

68 lines (45 loc) · 2.9 KB

🧪 RESTful API with Node.js and Express.js in TypeScript

Status

Node.js CI Quality Gate Status Codacy Badge codecov CodeFactor codebeat badge

About

Proof of Concept for a RESTful API made with Node.js LTS/Jod and Express.js 4 in TypeScript.

Structure

Simplified, conceptual project structure and main application flow

Figure: Simplified, conceptual project structure and main application flow. Not all dependencies are shown.

Install

npm install

Run

npm run dev

By default the application server will start as follows:

> ts-node-samples-express-restful@1.0.0 dev
> nodemon

[nodemon] to restart at any time, enter `rs`
[nodemon] watching path(s): src/**/*
[nodemon] watching extensions: ts
[nodemon] starting `ts-node ./src/server.ts`
[server]: Server is running at http://localhost:9000

You can change the port by setting the PORT environment variable in the .env file.

# /.env
PORT=9999

Documentation

http://localhost:9000/swagger/

API Documentation

Credits

The solution has been coded using Visual Studio Code.

Terms

All trademarks, registered trademarks, service marks, product names, company names, or logos mentioned on this repository are the property of their respective owners. All usage of such terms herein is for identification purposes only and constitutes neither an endorsement nor a recommendation of those items. Furthermore, the use of such terms is intended to be for educational and informational purposes only.