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

REST API made with TypeScript, NodeJS, Docker and MongoDB.
https://github.com/wendreof/api-ts

async-await js jsontocsv rest transpile

Last synced: 4 months ago
JSON representation

REST API made with TypeScript, NodeJS, Docker and MongoDB.

• Host: GitHub
• URL: https://github.com/wendreof/api-ts
• Owner: wendreof
• License: mit
• Created: 2019-08-31T13:15:16.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2022-12-22T12:31:15.000Z (over 2 years ago)
• Last Synced: 2025-01-16T11:26:54.602Z (5 months ago)
• Topics: async-await, js, jsontocsv, rest, transpile
• Language: TypeScript
• Homepage:
• Size: 721 KB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 13
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# API-TS

[![Twitter](https://img.shields.io/twitter/url?style=social&url=https%3A%2F%2Ftwitter.com%2Fwendreolf)](https://twitter.com/intent/tweet?text=Wow:&url=https%3A%2F%2Fgithub.com%2Fwendreof%2Fapi-ts%2F)

[![GitHub issues](https://img.shields.io/github/issues/wendreof/api-ts)](https://github.com/wendreof/api-ts/issues)

[![GitHub forks](https://img.shields.io/github/forks/wendreof/api-ts)](https://github.com/wendreof/api-ts/network)

[![GitHub stars](https://img.shields.io/github/stars/wendreof/api-ts)](https://github.com/wendreof/api-ts/stargazers)

[![GitHub last commit](https://img.shields.io/github/last-commit/wendreof/api-ts)](https://github.com/wendreof/api-ts/commits/master)

-------



    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.