https://github.com/openaq/aq-viz
Simple visualization of air quality data from OpenAQ.
https://github.com/openaq/aq-viz
Last synced: 16 days ago
JSON representation
Simple visualization of air quality data from OpenAQ.
- Host: GitHub
- URL: https://github.com/openaq/aq-viz
- Owner: openaq
- License: other
- Archived: true
- Created: 2015-07-19T14:11:12.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2016-02-27T17:52:26.000Z (about 9 years ago)
- Last Synced: 2025-03-26T09:45:11.515Z (about 2 months ago)
- Language: JavaScript
- Homepage: http://labs.openaq.org/aq-viz
- Size: 386 KB
- Stars: 5
- Watchers: 4
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# project-seed
A basic starting point for web projects
## Overview
## Gulp for building
The gulpfile is based on the [gulp-webapp](https://github.com/yeoman/generator-gulp-webapp) yeoman generator. The build system currently supports:
- Image optimization
- Sass compilation
- Watchify for JS bundling
- Minification/uglification where appropriate
- Serving and live reloading of pages
There are two commands, both run via npm.
- `npm run build` or `gulp build` or `gulp` - clean & build everything and put it into dist folder
- `npm run serve` or `gulp serve` - serve the pages and utilize live reload on changes to styles, fonts, images, scripts and HTML.
## Assets Structure
```
app/assets/
|
+- scripts/: The user scripts
| |
| +- config/: configuration files (see configuration section)
|
+- styles/: The sass styles
|
+- vendor/: Any third-party script that can't be required()
|
+- graphics/: Images for the site divided in:
| |
| +- layout/: Images for layout elements (Ex: background images)
| +- meta/: Images for the meta tags (Mostly icons and facebook images)
| +- content/: Content image
|
```
### Configurations and environment variables
At times, it may be necessary to include options/variables specific to `production`, `staging` or `local` in the code. To handle this, there is a master config.js file. This file should not be modified. Instead, modify one of:
- config/production.js - production settings
- config/staging.js - overrides the production settings for staging server (basically Travis not on the DEPLOY branch)
- config/local.js - local (development) overrides. This file is gitignored, so you can safely change it without polluting the repo.
When developing locally with `gulp serve`, the default will be to use `production` (with overrides from `local.js`). However, if you need to run with the staging settings, use: `DS_ENV=staging gulp serve` from the command line.
### How scripts are built
The script build, which uses `browserify`, outputs two js files: `bundle.js` and
`vendor.js`:
- `bundle.js`, created by the `javascript` task in deployment and by
`watchify` during development, contains all the app-specific code:
`app/scripts/main.js` and all the scripts it `require`s that are local to
this app.
- `vendor.js`, created by the `vendorBundle` task, contains all the external
dependencies of the app: namely, all the packages you install using `npm
install --save ...`.
## Travis for testing and deployment
The .travis.yml file enables the usage of [Travis](http://travis.org) as a test and deployment system. In this particular case, Travis will be looking for any changes to the repo and when a change is made to the `master` branch, Travis will build the project and deploy it to the `gh-pages` branch.
## semistandard for linting
We're using [semistandard](https://github.com/Flet/semistandard) for linting.
- `npm run lint` - will run linter and warn of any errors.
There are linting plugins for popular editors listed in the semistandard repo.