[Labs Starter App]

{This is a collection of boilerplate files for Labs repos. Replace this with a description of the application, customer, purpose, etc.}

{Replace this with a screenshot of the app.}

How we work

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 {link to waffle} to get an idea of our current priorities for this project.

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)
• Ember CLI
• {Replace this list with the app's dependencies.}

Local development

• Clone this repo command
• Install Dependencies command
• Start the server command

Architecture

{"Lay of the land" structure of the codebase, components...}

Backend services

• Carto - Description of this service
• github static content - Description of this service
• mapzen api - Description of this service
• {Replace this list with the app's backend service dependencies.}

Testing and checks

• 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 eslint at the command line with the --fix flag to automatically fix some errors.

• Testing

  • run ember test --serve
  • Before creating a Pull Request, make sure your branch is updated with the latest develop and passes all tests

Deployment

{Description of what type of hosting environment is required, and steps for how Labs deploys -- e.g git push dokku master.}

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 labs_dl@planning.nyc.gov