Front-end of code.gov
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci updated ci Nov 22, 2018
.github Initial documentation Nov 28, 2018
assets updated open tasks to pull from api Dec 15, 2018
config Created CODE_GOV_CONFIG_JSON env variable Dec 15, 2018
src call props' onUpdate method when html is loaded in LazyHTML component… Dec 17, 2018
styles pad footnotes Dec 15, 2018
.codeinventory.yml Create .codeinventory.yml Dec 7, 2018
.gitignore updated plugin system Nov 27, 2018
.nojekyll got initial blank page loaded with webpack and babel Sep 14, 2018
404.html updated 404 and project-page Nov 14, 2018
CODE_OF_CONDUCT.md Fix broken link Nov 30, 2018
CONFIGURATION.md Created CODE_GOV_CONFIG_JSON env variable Dec 15, 2018
CONTRIBUTING.md Update CONTRIBUTING.md Nov 21, 2018
DEPLOYMENT.md Create DEPLOYMENT.md Nov 14, 2018
LICENSE.md Create LICENSE.md Dec 7, 2018
README.md Fix readme.md headers Nov 29, 2018
STACK.md Create STACK.md Dec 12, 2018
Screen Shot 2018-12-08 at 10.19.03 AM.png fixed search result header for max-width: 600px Dec 8, 2018
dependency_licenses.json added dependency_licenses.json Nov 28, 2018
deploy.js renamed publish script to deploy to avoid confusion with npm publish Nov 22, 2018
index.html matching hot fix to production to handle repoID's of length greater t… Nov 27, 2018
package-lock.json new release after operation code hackathon Dec 15, 2018
package.json Update @code.gov/about-page version Feb 14, 2019
update-data.js updated data for filters Nov 20, 2018

README.md

Code.gov - Unlocking the potential of the Federal Government’s software.

Build Status Code Climate Test Coverage

Introduction

Code.gov is a website promoting good practices in code development, collaboration, and reuse across the U.S. Government. Code.gov provides tools and guidance to help agencies implement the Federal Source Code Policy. It also includes an inventory of government custom code to promote reuse between agencies and provides 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.

Requirements

The development of code.gov is guided by the requirements set forth in https://sourcecode.cio.gov/.

Configuration

For documentation on how to configure code-gov-front-end, go here.

Contributing

Here’s how you can help contribute to code.gov:

Questions?

If you have questions, please feel free to send us an email.

Getting Started

After you have cloned this repo, you can use npm install to install all of the project’s dependencies.

You can then run the server using npm run start.

By default, the development server will listen on http://localhost:8080/. You can change the default port by setting the PORT environment variable before starting the server (for example, PORT=3000 npm start).

Testing

Development of tests is in progress

Deployment

Read about how to publish to Github pages, Federalist and elsewhere here

Bundle analysis

https://federalist-proxy.app.cloud.gov/preview/gsa/code-gov-front-end/federalist-bundle-analysis/report.html

Deploying Arbitrary Branch

Coming soon!

Specifying an API Key

The app uses the API key provided in the site.json by default. If you want to override that, specify an CODE_GOV_API_KEY environmental variable. Here's an example:

CODE_GOV_API_KEY=l87sfdi7ybc2bic7bai8cb2i176c3b872tb3 npm run start

Generating License Data

To update the dependency_licenses.json file, run npm run licenses.

File Structure

The directories in src are organized around the pillars of React, along with several additional custom file types. When creating new files, be sure to add your file and any necessary templates, styles, and tests to a directory dedicated to your new file in the appropriate place.

Style Guide

We've moved the bulk of the CSS for this application into a Style Guide repository so that we can more easily keep things consistent and deploy changes more quickly.

You'll need to clone/download the Style Guide repository to get started.

If you need to make CSS changes, make them within this directory and commit them to that repository.

For more instructions on how to make changes, view the readme inside of the Style Guide repository.

License

As stated in CONTRIBUTING:

[..] this project is in the worldwide public domain (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.