An interactive mapping experience that highlights regional planning data and trends.
NYC Planning Labs takes on a single project at a time, working closely with our customers from concept to delivery in a matter of weeks. We conduct regular maintenance between larger projects.
Take a look at our sprint planning board to get an idea of our current priorities for this project.
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
- Report 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
You will need the following things properly installed on your computer.
- Git
- Node.js (with npm) version listed in .nvmrc
- Ember CLI
- Bower (
bower installis required for the remarkable and highlightsjs dependencies) - Google Chrome
- Clone this repo:
git clone git@github.com:NYCPlanning/labs-regional-viz.git cd labs-regional-viz- Install Dependencies:
npm install(oryarn) - Start the server:
ember serve- Visit your app at http://localhost:4200.
- Visit your tests at http://localhost:4200/tests.
-
ESLint - We use ESLint with Airbnb's rules for JavaScript projects
- Add an ESLint plugin to your text editor to highlight broken rules while you code
- You can also run
eslintat the command line with the--fixflag to automatically fix some errors.
-
Testing
- run
ember test --serve - Before creating a Pull Request, make sure your branch is updated with the latest
developand passes all tests
- run
npm run lint:hbsnpm run lint:jsnpm run lint:js -- --fix
ember build(development)ember build --environment production(production)
- Create a Dokku remote:
git remote add dokku dokku@{dokkudomain}:regional-viz - Deploy to Dokku:
git push dokku master
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 labs_dl@planning.nyc.gov