A generator for news apps. Built for Yeoman
npm install generator-newsapp
|36||downloads in the last week|
|40||downloads in the last month|
|Version||0.2.15 last updated 14 days ago|
|Keywords||yeoman-generator, newsapp, generator-newsapp, django|
|Dependencies||yeoman-generator, chalk, lodash|
Part of CIRs three-part deploy:
- Prompt to download popular JS libraries used in data-driven projects
- Livereload setup for reloading the web page on save
- Sass enabled with Libsass (so you don't need Ruby or Compass installed to use it!)
- Bower for dependency management
- Grunt tasks to optimize project for deployment to Amazon S3 or Github Pages
npm install -g generator-newsapp
gruntfor building, sass and js linting.
generator_newsapp comes with two template types: Django and Flat Graphic.
The Django template is meant to be used with CIR's django-project-template. These two libraries work together and brings some more modern frontend tooling to Django/Python web app development. Deployment is handled by the Django project template. Refer to those docs for minification and production builds of your web application.
Flat Graphic Template
If you don't need or use Django, the Flat Graphic template is the way to go. The Flat Graphic template contains the same dependencies and styles as the Django template, but also contains a built-in Node.js server for developing your project. There are also grunt tasks for minifying, concatenating, linting and building a production version of your application. Deployment is as easy as sending to Amazon S3 or Github Pages.
See the Yeoman deployment docs for deploying your finished app to Github Pages.
Third-party dependencies are managed with bower-install. Add new dependencies using Bower and then run the Grunt task to load them:
bower install --save jquery grunt bower-install
This works if the package author has followed the Bower spec. If the files are not automatically added to your index.html, check with the package's repo for support and/or file an issue with them to have it updated.
To manually add dependencies,
bower install depName --save to get the files, then add a
style tag to your
index.html or an other appropriate place.
Here are some features we'd like to include in no particular order:
- Grunt or Jake task to send
distfolder to Github Pages or Amazon S3
- Built-in templates for charts and other data-driven graphics
- Auto add
bower installdependencies to
- Test coverage and Travis CI integration for quality assurance
- Generic, non-CIR template for news apps
CIR loves open-source. Will this repo is currently tailored for our needs, we do hope to slowly turn this repo into a more generic and modular generator. Any and all ideas are welcome. Feel free to open an issue with any suggestions.