Skip to content

NYCPlanning/labs-home

Repository files navigation

NYC Planning Labs Website

planninglabs.nyc built with Gatsby.js

image

How you can help

In the spirit of free software, everyone is encouraged to help improve this project. Here are some ways you can contribute.

  • Comment on or clarify [issues](link to issues)
  • Report [bugs](link to bugs)
  • Suggest new features
  • Write or edit documentation
  • Write code (no patch is too small):

Requirements

You will need the following things properly installed on your computer.

Local development

  1. Clone this repo
    git clone [email protected]:NYCPlanning/labs-planninglabs-home.git
  2. Navigate to the project directory
    cd labs-planninglabs-home
  3. Install dependencies
    yarn
  4. Copy and rename .env-template, and fill in the correct Airtable API KEY (see 1password)
  5. Start your development server
    netlify dev
  6. Go to localhost:8000 in your web browser, make any code changes in the src directory and watch as your webpage automatically reloads to show your changes.

Optional

  • gatsby build — Gatsby will perform an optimized production build for your site generating static HTML and per-route JavaScript code bundles.
  • gatsby serve — Gatsby starts a local HTML server for testing your built site.
  • netlify dev

Backend services

Deployment

This project can be deployed on any static web server.

  • Deploy via Dokku using npm run deploy

Contact us

You can find us on Twitter at @nycplanninglabs, or comment on issues and we'll follow up as soon as we can. If you'd like to send an email, use [email protected]