turdus

command module
v0.0.0-...-eef4e93 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 9, 2020 License: MIT Imports: 1 Imported by: 0

README

turdus

Turdus is a genus of birds in the Turdidae family, comprising 66 species of blackbirds, thrushes, caraxués, and medium and large-sized sabiás, characterized by their rounded heads and long pointed wings, and generally having a melodious song. [Wikipedia]

turdus_rufiventris

Turdus is an interface to consume Twitter data based on specific searches, consolidating this data in file format for the user.

architecture

in soon.

how to install

make install

or via docker:

make docker/build

how to run

locally

You should export envs APP_PORT, TWITTER_API_URL , and TWITTER_TOKEN_BEARER with respective values.

make local/run/api

via docker:

You should create an .env file following the .env_sample file.

make docker/run/api

how to lint

make lint

how to test

make test

Documentation

Overview

main package

Directories

Path Synopsis
api
Package api is the package of the Turdus API interface
Package api is the package of the Turdus API interface
healthcheck
Package healthcheck is the package of the healthcheck API route
Package healthcheck is the package of the healthcheck API route
tweet
Package tweet is related with get tweets route
Package tweet is related with get tweets route
Package cmd is the package of the CLI resources
Package cmd is the package of the CLI resources
Package service is the service layer of the turdus project
Package service is the service layer of the turdus project

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL