National Science Foundation - Small Business Innovation Research
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
_data Update events_upcoming.yml Sep 24, 2018
_includes Update footer.html May 21, 2018
_layouts Update awardees.html Mar 30, 2018
_plugins Update awards_api.rb May 2, 2018
_sass Update _search.scss Apr 27, 2018
_styleguide pa11y-ci, changes to make site more accessible Jun 23, 2017
_timeline Fixed step 6 Apr 6, 2018
assets Add files via upload Jun 27, 2018
pages Update apply.md Sep 5, 2018
.dockerignore use Docker for local development Aug 25, 2017
.eslintrc Setting up linting and continuous integration Mar 9, 2017
.gitignore Split phase I and phase II (#767) Jul 18, 2017
.hound.yml Setting up linting and continuous integration Mar 9, 2017
.node-version pa11y-ci, changes to make site more accessible Jun 23, 2017
.rubocop.yml Setting up linting and continuous integration Mar 9, 2017
.ruby-gemset Initial site setup using the USWDS Jekyll theme Mar 8, 2017
.ruby-version 2.3.1 Mar 8, 2017
.scss-lint.yml Setting up linting and continuous integration Mar 9, 2017
Dockerfile use Docker for local development Aug 25, 2017
Gemfile Added sitemap gem for search engines Jun 23, 2017
Gemfile.lock Nokogiri update Apr 24, 2018
ISSUE_TEMPLATE.md reformat top section Aug 20, 2017
LICENSE.md Update LICENSE.md Jul 7, 2017
PULL_REQUEST_TEMPLATE.md remove Circle CI template (since we are no longer using it Aug 9, 2017
README.md use Docker for local development Aug 25, 2017
SAM.md Rename SAM to SAM.md Feb 28, 2018
_config.yml Config False Sep 7, 2018
new-page can add new page, with associated documentation May 15, 2017
serve use Docker for local development Aug 25, 2017

README.md

National Science Foundation SBIR Phase II (Build) Project

This is the home of the NSF SBIR Phase II (Build) Project.

Getting started

Most of our documentation can be found in the wiki. You can also find us in the #nsf-sbir Slack channel.

Set up the site locally

To set up the site on your local machine, follow these steps:

  1. Install and configure Git. If you're not comfortable with the command line, try GitHub Desktop.

  2. Download, install, and start Docker Community Edition.

  3. Clone the site. More detail on this.

    git clone https://github.com/18F/nsf-sbir.git
  4. Run the site!

    ./serve
  5. Visit at http://localhost:4000/site/

Creating new pages

You can create a new page by running the following command:

./new-page [name-of-page]

It will then create a file in the pages directory with the essential Jekyll front matter needed to get the page up and running

Accessibility

To check locally, we use pa11y-ci.

To get it working, do the following:

  1. Install pa11y-ci on the command line if you haven't already: npm install pa11y-ci -g
  2. In one terminal tab, get the site running: a. ./serve will create a local version of the site at http://localhost:4000/site/ a. bundle exec jekyll serve will create a local version of the site at http://localhost:4000/
  3. Then, in a new tab lint the site: a. If you used the ./serve command:
    pa11y-ci --sitemap http://localhost:4000/site/sitemap.xml --sitemap-exclude ".pdf"

b. If you used the bundle exec jekyll serve command: sh pa11y-ci --sitemap http://localhost:4000/sitemap.xml --sitemap-exclude ".pdf" 4. Alternatively, to check a single url: a. If you used the ./serve command: sh pa11y-ci http://localhost:4000/site/[name of link] b. If you used the bundle exec jekyll serve command: sh pa11y-ci http://localhost:4000/[name of link]