COVID-19 API Bahamas
This open-source project was created by Joseph Pinder as a read-only public API to make the Government of The Bahamas' COVID-19 reports available and accessible for data manipulation, analysis and presentation.
co-authored by Sowmya Thottambeti
How To Contribute
Since this is an open-source project, we are relying on the community's assistance. If you would like to contribute, continue reading the instructions below.
Technology
This API is generated with HUGO, a Golang static site generator (SSG).
Basic Installation
If you don't have HUGO already installed on your machine, you may follow Mike Dane's (@mikedane) tutorials on how to install it.
1) Mike Dane's Hugo - Static Site Generator | Tutorial
2) Mike Dane's YAML | In One Video
Git Tutorials
For non-coders, in addition to HUGO there's an additional knowledge requirement of Git.
Git is the means by which we access this Github repository to push (upload) and pull (download).
If you want to help out, you will need one or all of the following tutorials.
4) Git and GitHub for Beginners - Crash Course (Recommended)
1) Git Tutorial for Beginners: Command-Line Fundamentals
1) Git Tutorial for Beginners: Learn Git in 1 Hour
3) Learn Git In 15 Minutes
Forking the Repo.
On the top right corner of this repository, click the "Fork" button. By doing this, you will have your own copy of the repository and may freely experiment without affecting the original repository.
Cloning the Repo.
Let's navigate to your verison of the repository. This can be found on your profile under the list of repositories -- look for covid-api-bahamas.
Clone the repository on your local machine by running the following command: git clone <https url>. The https url value can be found by clicking the green dropdown with the word 'Code' on it, simply pressing 'HTTPS' and copying the url below that.
From the main branch, create a separate working branch. This can be done by running git checkout -b <branchName>. If your file is 343, your branch name would be report/343. If you would like to do a range of files, i.e. 343 - 350, your branch name would then be report/343-350.
You may see which files have been done already by evaluating the active pull requests and viewing the reports directory. Only select files which are free to take.
Create a new remote for the upstream repository by running git remote add upstream https://github.com/jsphpndr/covid-api-bahamas
Now, time to create an entry!
Creating a Data Entry
You will only be dealing with the contents/reports directory.
To create a new report, run the following command: hugo new reports/{{report.number}}.md
Running the previous command will create a new file report. For example, if your file is 343, then the result should be reports/343.md. You may see which reports have been done already by evaluating the active branches and viewing the reports directory
Entering the Data
Running the command, hugo new will populate the necessary fields to be updated.
You will find your newly created file well commented. Feel free to use the ad hoc variable library to speed up the process of filling in island name and sex values.
The flow of the report file corresponds in the reading manner of the physical report, left to right.
Contributions
We would also like to highlight you and the contribution that you made to this API.
Navigate to data/contributors.yml and follow the instructions there to add your name, and optionally, link to your personal or company website or social media page.
Where to find your name?
If you entered your name in data/contributors.yml your name will be featured on the homepage.
As a plus, if you add your name (and link) to the report file, it will be featured on the report page as follows:
Report 000 contributed by Your Name.
Make it a moment to shine and add something nice to the résumé.
Committing the Changes
After a self review ensuring that you have sucessfully followed the above steps, you are now ready to push your code.
In order to commit the new code, run the following code: git add . & git commit -m <message>. Your message should be 'report 343 by ' so, in my case, I would put 'report 343 by Sowmya Thottambeti'.
Once this is done, a simple git push should do the trick. If there is no upstream branch, you may have to use git push --set-upstream origin <branchName>
Pull Request
On the forked GitHub repo, create a pull request wherein you would merge your forked version into the original main branch. The title of your pull request should be 'report 343 by ' so, in my case, I would put 'report 343 by Sowmya Thottambeti'.
A member from our team will review the pull request and if everything was done correctly, we will gladly merge it into the main branch.
Resource
You may locate the series of reports for the year 2021 on the government's website.
Reports are listed in globs, i.e. "COVID-19 Report Update #547 - #553".
Older listings from the year 2020 are found here.
Contact
For any questions and/or concerns, feel free to fill out the form.