Skip to content

fairfield-programming/standards

Repository files navigation

Fairfield Programming Association Vault Tweet

The Fairfield Programming Association Standards website provides open access to anyone who would like to adapt standards put forth by the FPA.

GitHub contributors GitHub commit activity Website GitHub issues GitHub Org's stars GitHub top language

The new Fairfield Programming Association Standards website is built in Gatsby and uses Tailwind CSS for the styling. This enables us to keep down server costs while also providing an excellent user and developer experience. Most of our pages are DSG (Deferred Static Generation), which means that most of the information on the website can be changed by modifying the information inside of the data folder.

Features

Create

On /create page, the user can use the in-browser standard editor to create a standard file. On the left pane, the user can type in code. At the same time, on the right pane, a preview of the rendered standard document will appear.

Search

The search feature lets users search for standards based on the name, authors, or category of the standard. This feature allows people to quickly access what they are looking for and adds to the maintainability of the entire website in the long term.

Setup

  1. Download the project from Github.

  2. Have Node, NPM, and Gatsby installed.

  3. Run the below command to install the packages.

npm install
  1. Run the below command to start the website.
gatsby develop

Note: It can take anywhere from a few seconds to a few minutes to start the website, but once the website is live, it does hot reloading.

Contribute