search

socialappslab / appcivist-pb-client

Web Client of AppCivist, for the instance of Participatory Budgeting
Other
4 stars 2 forks source link
angular civic-engagement civic-tech democracy grunt participatory-budget participatory-democracy

readme

appcivist-pb-client

Web Client of AppCivist, for the instance of Participatory Budgeting

Installation

Before running the App, you will need to do the following:

  1. Install Nodejs and NPM (Node Package Manager)

    $ apt-get install curl
$ curl --silent --location https://deb.nodesource.com/setup_0.12 | sudo bash -
$ apt-get install nodejs
$ apt-get install npm

  2. Using NPM, install Bower package manager

    $ npm install -g bower

  3. Install [Grunt]()

    $ npm install -g grunt-cli

  4. Install the CSS authoring framework Compass (you will need Ruby first)

    $ apt-get install ruby ruby-dev
  $ gem update --system
  $ gem install compass

  5. Install the Sass language

    $ gem install sass

  6. Install haml

    $ gem install haml

  7. Update the API URLs in app.js to use your local/test/production APIs

Run

  1. Get the code

    $ git clone https://github.com/socialappslab/appcivist-pb-client.git

  2. You need to download the dependencies before run the application so,

    $ npm install

  3. Now you can run the app typing,

    $ grunt server

  4. Alternatively, you can use the packaged HTML/JS/CSS version and configure your HTTP server to have index.html as index in that directory

grunt build
cp -rf dist/* /path/to/html/version/appcivist-pb

  1. Try visiting the following routes:

    1. Go to localhost:8000
    2. Login with these credentials: bob@example.com / secret => /home
    3. Click on "+ Assembly" => /assembly/create
    4. Click "Start Assembly" => /assembly/1/forum
    5. Click "Assemblies" => /assemblies
    6. Click "+Campaign" => /assembly/1/campaign/create

  2. For deployment, consider using this sample to create an init.d script and then follow this guide to make sure the service is enabled.

If you have problems maybe you can configure your git with this: git config --global url."https://".insteadOf git://

Contributing

Generate documentation

jsdoc is used to generate documentation from source code. To update the documentation issue the following:

$ grunt jsdoc

Then just open docs/index.html in your browser.

Copyright

Created by the Social Apps Lab at CITRIS, University of California, Berkeley. The Social Apps Lab Team is led by Prof. James Holston (Director) and Dr. Cristhian Parra (Chief Developer). In partnership with the MiMove Team at INRIA, France, led by Dr. Valérie Issarny. This project was developed with funding from the EIT Digital, as a part of the EIT-Digital Activity CivicBudget in collaboration with TUB, Nexus, and Missions Publiques. Contributions from City of Vallejo, and Participa Project at DEI/Universidad Católica de Asunción (UC). 2017 © Regents of the University of California

License

All the components of this software are provided under a dual license model designed to meet the development and distribution needs of both open source projects and commercial use.

For open source projects, AppCivist is distributed free under the terms of the Social Apps Lab Open Source License. If you intend to use this software for commercial purposes, contact the project members below.

Who do I talk to?