An open API service indexing awesome lists of open source software.

https://github.com/samuel-ricardo/tweets-monitor

A NestJS API to monitoring a database updated with tweets in real time
https://github.com/samuel-ricardo/tweets-monitor

Last synced: 3 months ago
JSON representation

A NestJS API to monitoring a database updated with tweets in real time

Awesome Lists containing this project

README

        

# Tweets Monitor





🚀 🟥 Discovery 🟥 🚀


Application developed with the purpose of studying the NestJS Ecosystem

#


|  
Overview   |   
Technologies   |   
Project   |  
Routes   |   
Run   |  
Author   |   

#


| :artificial_satellite: About:


This API simulate that receive tweets of a database and monitor this tweets using advanced technologies like queues, redis, scheduler, docker and more.



:building_construction: | Technologies and Concepts Studied:

>

- NestJS
- Sqlite
- Sequelize
- Redis
- MySQL
- Typescript
- JS
- Test
- Jest
- Docker
- eslint
- prettier
- husky
- Bull
- cache-manager
- schedule | crono
- lint-sataged

> Among Others...


#


💻 | Application:


This application use a scheduler to get tweets of a sqlite database and detail theys using queues from time to time, keeping it on redis.


> API Example:

```bash

GET http://localhost:3000/tweets

###
POST http://localhost:3000/tweets
Content-Type: application/json

{
"text": "Nice Tweet :D"
}

```
#



👨‍💻 | How to use


### Open your Git Terminal and clone this repository

```git
$ git clone "[email protected]:Samuel-Ricardo/tweets-monitor.git"
```

### Make Pull

```git
$ git pull "[email protected]:Samuel-Ricardo/tweets-monitor.git"
```


This application use `Docker` so you dont need to install and cofigurate anything other than docker on your machine.

>


Navigate to project folder ` $ cd ./schedule-queue/ ` and run it using ` docker-compose `

```bash

# After setup docker environment just run this commmand on root project folder:

$ docker-compose up --build # For First Time run this command

$ docker-compose up # to run project

```

```bash

#Apps Running on:

$ API: http://localhost:3000

$ Redis: http://localhost:6379

See more: ./schedule-queue/docker-compose.yaml

```


#


#


:octocat: | Author:

>

- Samuel Ricardo