Skip to content

Latest commit

 

History

History
80 lines (48 loc) · 3.37 KB

README.md

File metadata and controls

80 lines (48 loc) · 3.37 KB
Raw

This site is an Ottawa Civic Tech volunteer project. It is not affiliated with the Government of Canada.

Is this blocked in my department.ca

This repository powers isthisblockedinmydepartment.ca.

It's based on Gatsby, a fast, high-performance static site builder built with React.

This site uses the Gatsby default starter.

Before following the installation steps below, make sure that an up-to-date version of Node.js is installed on your computer. For more details on the development environment, see the Gatsby introductory tutorial.

How it works

Isthisblocked uses the gatsby-transformer-csv plugin to parse CSV files that contain data on departments and services.

The source data displayed on the website is in CSV format in the /src/data folder.

The organization_status.csv file is updated with new information on services that are open, restricted, or blocked in each department.

This data is anonymously crowdsourced from the Google Forms linked at https://isthisblockedinmydepartment.ca/suggest.

Raw data from these forms is manually added to the organization_status.csv file.

Scores for each department are calculated using the criteria described on the Scoring page.

Future feature possibilities include:

  • built-in data collection using Firebase or other back-end services
  • embedded previews of services to quickly review which are blocked
  • automatic tallying and averaging of crowdsourced data

For questions or feedback on this website, email [email protected].

Local installation

  1. Install the Gatsby CLI.

    # Install the Gatsby CLI globally
npm install -g gatsby-cli

  2. Clone this repository.

    # Clone the repository 
git clone [email protected]:isthisblocked/isthisblockedinmydepartment.ca.git isthisblocked

  3. Install package dependencies.

    This may take several minutes to install.

    cd isthisblocked/
npm install

  4. Start developing.

    Once all packages are installed successfully, start it up!

    gatsby develop

  5. Open the source code and start editing!

    Your site is now running at http://localhost:8000!

    Note: You'll also see a second link: http://localhost:8000___graphql. This is a tool you can use to experiment with querying your data. Learn more about using this tool in the Gatsby tutorial.

    Open the the isthisblocked directory in your code editor of choice and edit src/pages/index.js. Save your changes and the browser will update in real time!

  6. Deployment via Netlify

    This site is hosted by Netlify, and automatically deploys the production site when new commits are pushed to the master branch.