CSS JavaScript HTML Ruby
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
src
.bowerrc
.editorconfig
.gitattributes
.gitignore
.jshintrc
.travis.yml
Gemfile
Gemfile.lock
README.md
_config.build.yml
_config.yml
bower.json
circle.yml
contributing.md
gulpfile.js
package.json
s3_website.yml
yarn.lock

README.md

SDStreets

About

StreetsSD is a simple front-end visualization tool for displaying work completed.

Contributing Code / Feature Requests / Bug Reports

Please review the contributing guidelines

Getting Started

Requirements

  • Ruby (you can use rvm to install)
  • Node
  • CartoDB (since you won't have access to the CartoDB map to get this working, you will simply just need to repicate it and change the key);

Running.

  • Clone the repo
  • bundle install
  • npm install
  • gulp to begin watching and compiling.

Languages

The application is supported by several languages. They are here in no particular order:

  • Javascript
  • Ruby
  • SCSS
  • CSS
  • HTML

Frameworks / Libraries / Tools

The application is designed to use Jekyll for partials and templating. It's using Gulp for controlling the build. For more information about this setup please see the Jekyllized README.

The backend of the application is mainly CartoDB. As various JS events happen, a query is constructed and sent off to CartoDB as an api, and then the response is displayed.

C3 is used for charting, and Squel.js for constructing queries to send to CartoDB.

Static assets are hosted on S3 as needed.

The hosting for staging is handled by Surge, and production runs on Github Pages.

Analytics are supported by Google Tag Manager, Google Analytics and HotJar.

Deployment is supported by CircleCI.