README.md

Built with Gatsby.js

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)
  • Fix typos
  • Add comments
  • Clean up code
  • Add new features

Read more about contributing.

Requirements

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

• Git
• Node.js (with NPM)
• gatsby-cli (to run Gatsby commands)
• Yarn

Local development

• Clone this repo git clone git@github.com:NYCPlanning/labs-planninglabs-home.git
• Navigate to the project directory cd labs-planninglabs-home
• Run yarn to install dependencies
• gatsby develop — Gatsby will start a hot-reloading development environment accessible at localhost:8000. Edit the javascript pages in src/pages. Saved changes will live reload in the browser.
• 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.

Backend services

• Airtable (used to manage project content)
• labs-ideas-api (pulls in projects from Airtable)

Deployment

This project can be deployed on any static web server.

• Deploy via Dokku using npm run deploy