valecia2023/open-gsa-redesign

A fresh start for open.gsa.gov.

Open GSA Redesign

Open.gsa.gov is the current developer portal for all GSA data, APIs, and code open to the public. This repo is where we will be managing development of the redesign of this portal.

This particular site is made for use with the Federalist in mind.

See the wiki for more info related to this site including a product roadmap, personas, and guides.

Running locally

This site is built using Jekyll for the file framework.

Before you start

You will need to have the following installed on your machine before following the commands below:

• Ruby v2.2.2+, Installation guides
• Bundler v1.12.3+, Installation guides

Basic setup

1. Install Bundler gem install bundler and then install Jekyll and all dependencies bundle install.
2. Fork this repo.
3. Clone the repo you just forked.

Running Jekyll

The preferred method for running Jekyll is with bundle exec jekyll serve.

Note that this method will rebuild the entire site every time you make a change to any file. If you want faster builds, you can use bundle exec jekyll incrementalserve, which comes with some caveats, notably only changed files will be rebuilt. This means if you change a data file, HTML pages that use that data file won't be updated.

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.