Skip to content

ntineloveu/REST-Demo

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

REST API Demo

Mostly based on jasonhodes/hypermedia-tutorial

Setup

Just clone this repository and run npm install or yarn to install required dependencies

Up and Running

Use npm start to start the server. This project use nodemon and ts-node to run the project.

A bit about the project

This project is written in TypeScript, use express as a web framework with body-parser middleware to handle the JSON request/response. This project also use nedb which provide a lightweight NoSQL-like embeded database.

This project is best to work with Visual Studio Code, however, it can be work with any modern editor or IDE of choices.

Project progress

Each iteration of the project is assigned with git's tags. You can checkout each tagged commit to see how the project evolved with its API.

Suggestions

This project also provide .editorconfig file to keep editor settings the same way as intended. Check out EditorConfig to see which editor supports such feature.

About

A sample project in the REST API workshop

Resources

Stars

Watchers

Forks

Packages

No packages published