Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/18F/api.data.gov

A hosted, shared-service that provides an API key, analytics, and proxy solution for government web services.
https://github.com/18F/api.data.gov

Last synced: 9 days ago
JSON representation

A hosted, shared-service that provides an API key, analytics, and proxy solution for government web services.

Host: GitHub
URL: https://github.com/18F/api.data.gov
Owner: 18F
License: other
Created: 2013-07-17T05:21:11.000Z (over 11 years ago)
Default Branch: main
Last Pushed: 2024-10-26T21:44:29.000Z (18 days ago)
Last Synced: 2024-10-26T23:25:09.824Z (18 days ago)
Language: JavaScript
Homepage: https://api.data.gov
Size: 2.84 MB
Stars: 97
Watchers: 147
Forks: 43
Open Issues: 29
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md

Awesome Lists containing this project

README

        [![CI](https://github.com/18F/api.data.gov/workflows/CI/badge.svg)](https://github.com/18F/api.data.gov/actions?workflow=CI) [![Code Climate](https://codeclimate.com/github/18F/api.data.gov/badges/gpa.svg)](https://codeclimate.com/github/18F/api.data.gov) [![Known Vulnerabilities](https://snyk.io/test/github/18F/api.data.gov/badge.svg?targetFile=Gemfile.lock)](https://snyk.io/test/github/18F/api.data.gov?targetFile=Gemfile.lock) [![Known Vulnerabilities](https://snyk.io/test/github/18F/api.data.gov/badge.svg?targetFile=requirements.txt)](https://snyk.io/test/github/18F/api.data.gov?targetFile=requirements.txt)

# api.data.gov

[https://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.

- [Program Notes for api.data.gov](https://github.com/18F/api.data.gov/wiki/Program-Notes)

- [GitHub Repository for API Umbrella](https://github.com/NREL/api-umbrella), the underlying technology of `api.data.gov`

## 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](https://gohugo.io).

All contributions are welcome. To submit a change, fork this repo, commit your changes, and send us a [pull request](https://help.github.com/articles/using-pull-requests).

## 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:

```sh

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/](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](https://github.com/18F/api.data.gov/actions/workflows/main.yml).

## Public domain

This project is in the worldwide [public domain](LICENSE.md). As stated in [CONTRIBUTING](CONTRIBUTING.md):

> 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](https://creativecommons.org/publicdomain/zero/1.0/).

>

> 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.