Giters

meetDeveloper / freeDictionaryAPI

There was no free Dictionary API on the web when I wanted one for my friend, so I created one.

Home Page:https://dictionaryapi.dev/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Add a page to check if the server is up

devadathanmb opened this issue · comments

commented

The API is definitely great and very useful. But I seem to notice that the server seems to be down at times. And currently, at the time of writing this issue, it's down as well.
It would be helpful if you could create a page to monitor the stats of the server.

commented

I've taken the liberty of configuring a repository to make Upptime do the heavy lifting, doing tasks such as:

  • Monitoring outages for the FreeDictionary API landing page
  • Performing a test GET request to assess API endpoint status, to https://api.dictionaryapi.dev/api/v2/entries/en/hello.
  • Creating a status page with fancy graphs and some basic info about the API itself.

I've additionally edited minor details such as directing links to the FreeDictionary API GitHub repo, setting up the favicon, intro text etc.
Currently, the repo lives here, and all relevant config details are in the .upptimerc.yml file.

@meetDeveloper, please let me know if this looks good to you.
If I did everything correctly, and all seems okay to you as well, we'd just need to fork my repo, tweak some GitHub settings (for setting up GitHub Pages and Actions), edit the README and be done with it. If there is a better way to go about things, please let me know, and I'd be happy to help!

Thanks again for the great work in developing this API :)

commented

@BSGalvan Thanks a lot for putting so much efforts into this. I will try to see how I can integrate this with Dictionary API. Again thanks for your effort and you did fantastic work. :)

commented

@BSGalvan Will it be possible to create PR to this repo itself for uptime monitoring? I want to have everything in this repo and we can modify the Readme file of this repo to have the status details

commented

That may be slightly convoluted, since Upptime creates issues within the repository to track incidents, and uses that repo's Actions to generate the status page and other updates.

I have not yet looked into the scenario of generating status reports for an existing repository, and while I'm not signing off on that possibility, I'd say the cleanest (and quickest!) way would be to have the status reporting in a separate repository.
If you wish to point users to a status page, maybe a link (to either the status page or the status repository) at the end of the README in this repository would suffice?
Let me know what you think about this.