ashleanichols/api-all-the-x

Resources and Materials for the /Developer Program

/Developer Program

Description

A project of 18F API Engagement, the contents of this project now be found in this folder.

How to contribute

Please suggest further projects, ask questions, or otherwise share thoughts in the issues tracker. Pull requests are welcome.

Submitting a Pull Request

Please refer to CONTRIBUTING.md for instructions and guidelines.

Submitting an Issue

We use the GitHub issue tracker to track bugs and features. Before submitting a bug report or feature request, check to make sure it hasn't already been submitted. When submitting a bug report, please include a screenshot and any additional details that can help us debug, such as your operating system and browser version.

Running the Site Locally on Your Computer

To run the site locally on your own computer (most helpful for previewing your own changes), you will need to install Jekyll and other dependencies:

If you don't already have Ruby and Bundler installed, follow the first two steps in these Jekyll installation instructions.

Fork this repository to your GitHub account and clone it on your computer.

Go to the root directory of the repo and install the dependencies:

cd API-All-the-X
bundle install

Run the Jekyll server and watch for file changes:

jekyll serve --watch --baseurl ''

Your computer should now be serving your local copy of the site at:

http://0.0.0.0:4000.

Public domain

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.