okfn-brasil / mosaico

Visualization on the brazilian budget for FGV
GNU Affero General Public License v3.0
5 stars 0 forks source link

README

List of dependencies

Project installation

To install the project, simply type:

$ npm install

…and…

$ bower install

This should install all dependencies necessary for running the project.

Running the server for local development

To run the server just type on the shell:

$ grunt server

This will run the server and also open the home page of the project on localhost:9000 on your browser.

Commiting code to the codebase

To create the final files for commit, use:

$ grunt build

IMPORTANT: You should always commit all files on the repository, by doing:

$ git add . && git commit -a

This will add all files and remove all deleted files from the repository at the end of the build process.

Credits

Development: Open Knowledge and Open Knowledge Brasil

Project by: FGV-DAPP

License

See LICENSE.txt.