antonioalmeida/ditado-api

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

ditado-api's Issues

Add eslint support

The project has a linter setup but no specific codestyle is enforced

Github Actions/Heroku Deployment

Hello this is not an issue actually, I just read on your README this:

Github Actions had just came out and I wanted to learn all about it, namely how to automate deployments via Heroku. Fetching ditados seemed like the perfect excuse. Also inspired by this.

I just want to let you know that you can actually create automatic deployments in heroku even without github actions. That would be more way convenient. If you want to learn more about github action I suggest you can make some automated test, or some sort of thank you message for every issue. :)

Create /generate endpoint

Ditados are cool, but we need more. Let's create some!

Introducing /generate:

• Returns a made up ditado
• Made by stitching up two halves of known ditados
  • Example: "[Ladrão que rouba a ladrão] [todo o buraco é trincheira]"
• Essentially a blatant copy of @henriquetguedes' ditado-generator functionality (with consent)

We can copy his data and go from there.

Later I'm thinking of building a bot that publishes a generated ditado per day to Mastodon

Add your own ditado

Add your own ditado to the collection!

As per the project's README.me:

• 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 🎉

Add endpoint to retrieve random entry

At the moment only the entire document can be fetched, but retrieving a random entry would be way more interesting.

I'm leaving this issue open on purpose because it it quite simple and a beginner might try and have a go at it.

Add ditados.json format validation

Implement some form of static validation on the ditados.json file that is ran in PRs and blocks merges if there are problems

Remove old Node.js versions

No need to support node 8, 10, and 12 anymore

Create test directory

Test files shouldn't be in the main repository folder, but have a proper directory, e.g., __tests__

Find another free host

Heroku deployment no longer works because free tier was decommissioned. Find an alternative and setup deployment via Github Actions

Rewrite in Typescript

It's 2022, we can do better

Update documentation

We now use fly.io instead of Heroku