https://github.com/antonioalmeida/ditado-api

Public API to serve ditados, i.e., popular portuguese sayings.
https://github.com/antonioalmeida/ditado-api

flyio github-actions hacktoberfest nodejs

Last synced: about 18 hours ago
JSON representation

Public API to serve ditados, i.e., popular portuguese sayings.

• Host: GitHub
• URL: https://github.com/antonioalmeida/ditado-api
• Owner: antonioalmeida
• License: mit
• Created: 2019-10-15T19:29:33.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2024-11-18T19:41:22.000Z (2 days ago)
• Last Synced: 2024-11-18T20:41:55.216Z (2 days ago)
• Topics: flyio, github-actions, hacktoberfest, nodejs
• Language: JavaScript
• Homepage: https://ditado-api.fly.dev/ditados/random
• Size: 1.33 MB
• Stars: 10
• Watchers: 3
• Forks: 21
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ditado-api

Public API to serve _ditados_, i.e., popular Portuguese sayings.

## Why?

[Github Actions](https://docs.github.com/en/free-pro-team@latest/actions/learn-github-actions/introduction-to-github-actions) had just come out and I wanted to learn all about it, namely how to automate deployments via [Heroku](https://heroku.com).

Fetching _ditados_ is an easy enough use case. Also inspired by [this](https://github.com/msramalho/json-tv-quotes).

*Update:* since the original release Heroku has decomissioned their free tier. We're now using [fly.io](https://fly.io), and Github Actions has considerably matured. I now use this to play around.

## API

Public REST API available at https://ditado-api.fly.dev

- `GET /ditados` - Fetch all entries

- `GET /ditados?q=pequenino` - Search for a ditado matching a particular word

- `GET /ditados/random` - Fetch a random ditado.

- `GET /ditados/generate` - 🆕 Create a new ditado! Inspired by [ditado-generator](https://github.com/henriquetguedes/DITADOgenerator)

## Contribute

- Fork this repo and edit `ditados.json`;

- Add a _ditado_, including what it means under the `meaning` field:

```

{

   "ditados":[

      (...)

      {

         "content":"Your ditado",

         "meaning":"What it means"

      }

   ]

}

```

- Submit a PR and celebrate 🎉