Skip to content

Latest commit

 

History

History
68 lines (42 loc) · 1.86 KB

README.md

File metadata and controls

68 lines (42 loc) · 1.86 KB
Raw

API-TS

Twitter GitHub issues GitHub forks GitHub stars GitHub last commit

Motivation • Installation • Running • Routes • License

Motivation

This project is a REST API made in TypeScript (JavaScript superset) with Docker containers, Redis to caching and MongoDB as database.

Installation

  • Clonning the repository

git clone https://github.com/wendreof/api-ts.git

Get Docker on https://www.docker.com/ to run the following steps.

  • Turning up

docker run -d -p 27017:27017 -p 28017:28017 -e AUTH=no tutum/mongodb

docker run -d -p 6379:6379 redis

docker exec -it redis redis-cli

docker build .

Running

  • Starting commands

npm run compile

npm start

  • The server is running on port 3050, available on browser and will return the API's version:

Routes

  • GET/POST

localhost:3050/api/v1/news

  • DELETE

localhost:3050/api/v1/news/IDHASHHERE

  • PUT

localhost:3050/api/v1/news/IDHASHHERE

License

This project is licensed under the terms of the MIT license. See the LICENSE file.