Scotchester / code-gov

An informative repo for all Code.gov repos

code-gov

An informative repo for all Code.gov repos

What is Code.gov

Code.gov is a website and program promoting good practices in code development, collaboration, and reuse across the U.S. Government. Code.gov will provide tools and guidance to help agencies implement the Federal Source Code Policy. It will include an inventory of the government's custom code to promote reuse between agencies and will provide tools to help government and the public collaborate on open source projects.

To learn more about the project, check out this blog post.

Code.gov is an open source project, so we invite your contributions, be it in the form of code, design, or ideas.

Repositories

As a project, Code.gov is a collection of repositories that enable the collection of source code inventory files. All of our work is open source and we encorage you to take a look and, if you wish, contribute to our projects by submitting a pull request, Github Issue, or commenting on existing issues and pull requests.

1. GSA/code-gov-web: Our frontend project. Currently deployed as a static site, this project consumes a series of JSON files to display project repositories, client-side search index, and agency compliance dashboard.
2. GSA/code-gov-api: Our backend API. An Express.js app backed by Elasticsearch. Its primary function is to index and make America's source code discoverable and searchable.
3. GSA/code-gov-harvester: Our standalone source code inventory harvester. Currently this application generates the files needed by our frontend to display project repositories and our client-side search index. It also generates the data for the agency complaince dashboard.
4. GSA/code-gov-developer-docs: Our developer docs! This repo is meant to be a simple way to start using our API and what you need to do so. It will also let our users get an API token.
5. GSA/code-gov-style: Our effort to modularize our CSS styles.

Miscellaneous Repositories

These repos are marked as miscellaneous because they do not affect the development or deployment of our main repos.

1. GSA/code-gov-stats
2. GSA/code-gov-stats-jupyter-notebook

Each of our repositories follow our Code of Conduct and Contributing guidelines.

Communications

As an open source project we love feedback. If you want to get a hold of us you can use one of the following ways:

1. Twitter: @CodeDotGov
2. Email: [e-mail]
3. LinkedIn: code-gov

You can also submit an issue on this repository or on one of our other projects:

1. code-gov-web issues
2. code-gov-api issues
3. code-gov-harvester issues

Thanks!