NYC Planning Labs Website
planninglabs.nyc 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 [email protected]:NYCPlanning/labs-planninglabs-home.git
- Navigate to the project directory
cd labs-planninglabs-home
- Install dependencies
yarn
- Start your development server
gatsby develop
- Go to
localhost:8080
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.
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
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]