search

18F / api.data.gov

A hosted, shared-service that provides an API key, analytics, and proxy solution for government web services.
https://api.data.gov
Other
98 stars 43 forks source link

readme

CI Code Climate Known Vulnerabilities Known Vulnerabilities

api.data.gov

https://api.data.gov is a free API management service for federal agencies. Our aim is to make it easier for agencies to release and manage APIs.

Notes

To edit this site, edit the main branch. Changes should take effect within minutes.

The website content for api.data.gov built with Hugo.

All contributions are welcome. To submit a change, fork this repo, commit your changes, and send us a pull request.

Development

The content files to edit are in ./content. You can view your changes as you make them by running the preview server in Docker. Assuming you have Docker installed on your development computer:

git submodule update --init --recursive # Make sure to pull in git submodules

docker compose up

This will start a local web server running at http://localhost:4490/

After you're happy with your changes, commit and submit a pull request.

Deploy

Changes pushed to main should automatically be published to production within a few minutes via the CI GitHub Action.

Public domain

This project is in the worldwide public domain. As stated in CONTRIBUTING:

This project is in the public domain within the United States, and copyright and related rights in the work worldwide are waived through the CC0 1.0 Universal public domain dedication.

All contributions to this project will be released under the CC0 dedication. By submitting a pull request, you are agreeing to comply with this waiver of copyright interest.