Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/CitizensFoundation/your-priorities
This version is depricated. Please use the new version at
https://github.com/CitizensFoundation/your-priorities
Last synced: about 2 months ago
JSON representation
This version is depricated. Please use the new version at
- Host: GitHub
- URL: https://github.com/CitizensFoundation/your-priorities
- Owner: CitizensFoundation
- Created: 2013-07-23T16:07:56.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2016-05-13T15:50:01.000Z (over 8 years ago)
- Last Synced: 2024-04-16T14:13:11.960Z (5 months ago)
- Language: Ruby
- Homepage: https://github.com/rbjarnason/your-priorities-app/
- Size: 9.13 MB
- Stars: 34
- Watchers: 14
- Forks: 35
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# This version is depricated
Please use the new version at https://github.com/rbjarnason/your-priorities-app/
# Old Your Priorities version
Your Priorities is a web based platform that enables groups of people to define their democratic ideas and together discover which are the most important ideas to implement by their instances. People can add new ideas, add arguments for and against ideas, indicate if they support or oppose an idea, create a personal list of ideas and discuss all ideas. The end results are lists of top ideas in many categories as well as the best arguments for and against each idea. This service enables people to make up their minds about most issues in a short time.
Your Priorities is being used on the https://www.yrpri.org/ eDemocracy service and the Better Reykjavik website in Iceland amongst other places.
Docker on Ubuntu
================
Install docker
````bash
Visit http://docs.docker.io/en/latest/
````
Install git
````bash
sudo apt-get install git
````
Clone Your Priorities locally
````bash
cd /yourpath
git clone https://github.com/rbjarnason/your-priorities.git
````
Copy database config template (no change needed):
````bash
cd your-priorities
cp config/database.yml.dist config/database.yml
````
Option 1 - Install Your Priorities images from Docker Index
````bash
sudo docker pull yrpri/base
sudo docker pull yrpri/postgresql
sudo docker pull yrpri/rails
(optional IRC support)
sudo docker pull yrpri/ngircd
sudo docker pull yrpri/kiwiirc
````
Option 2 - Build docker repositories from github dockerfiles
````bash
# Base docker repository
git clone https://github.com/rbjarnason/docker-base.git
cd docker-base
sudo docker build -t yrpri/base .
cd ..
And the same for:
https://github.com/rbjarnason/docker-postgresql.git and yrpri/postgresql
https://github.com/rbjarnason/docker-rails.git and yrpri/rails
(optional IRC support)
https://github.com/rbjarnason/docker-ngircd.git and yrpri/ngircd
https://github.com/rbjarnason/docker-kiwiirc.git and yrpri/kiwiirc
````
Start database
````bash
sudo docker run -i -t -d --name postgresql -v MY_DB_FOLDER:/var/lib/postgresql yrpri/postgresql
````
Optional IRC support
````bash
sudo docker -D run -d -p 6667:6667 yrpri/ngircd
sudo docker -D run -d -p 7778:7778 -v /root/certs:/etc/kiwiirc -e KIWI_IRC_SERVER_HOST=irc.yrpri.org -e KIWI_IRC_SERVER_PORT=6667 yrpri/kiwiirc
````
Start rails docker image pointing to your local Your Priorities installation
````bash
sudo docker -D run -d -link postgresql:db -p 3000:3000 -v /yourpath/your-priorities:/var/www/your-priorities -e APP_NAME=your-priorities yrpri/rails
````
See if it is running
````bash
sudo docker ps
````
Test it
````bash
The image will take a little while to start up, it will have to run bundle install each time its started.
Browser to http://localhost:3000/ or http://your.ip.addr.number:3000
````
Debug the docker image
````bash
sudo docker ps -notrunc
sudo lxc-attach --name long_uid_from_docker_ps
cd /var/log/supervisor
tail -f *
````
Default admin user and password
````bash
[email protected]
admin
````
Setup the project locally
=========================
Fork the project from github.com
````bash
1. Create a github account if you do not have one
2. Make sure you are logged in
3. Click the "Fork" button at the top of the page to create your own fork
````
Download / clone on your local Ubuntu installation
````bash
(replace YOURNAME with your github username)
git clone [email protected]:YOURNAME/your-priorities.git
````
Setup git to easily merge from the main branch
Add the following to the .git/config file
````bash
[remote "robert"]
url = [email protected]:rbjarnason/your-priorities.git
fetch = +refs/heads/*:refs/remotes/robert/*
````
Merge the latest changes from the master branch
````bash
git fetch robert
git merge robert/master
````
Development on Linux
====================
Install rvm the Ruby version manager
````bash
sudo apt-get install curl
\curl -L https://get.rvm.io | bash -s stable
````
Go into the application and install all gems
````bash
sudo apt-get install build-essential
sudo apt-get install libxslt-dev libxml2-dev
sudo apt-get install libmysqlclient-dev
sudo apt-get install libpq-dev
sudo apt-get install libmagickwand-dev
bundle install
````
Install database dependencies
````bash
sudo apt-get install postgresql
sudo apt-get install mysql-server
````
Then start the psql shell
````bash
sudo su postgres
psql
````
When in psql create a user and the Your Priorities dev database
````bash
CREATE USER puser PASSWORD 'xxxxxxxx'
CREATE DATABASE yrpri_dev WITH ENCODING 'utf8';
GRANT ALL PRIVILEGES ON DATABASE yrpri_dev TO puser;
ALTER USER puser CREATEDB;
````
Then exit the postgres shell and copy and edit the config/database.yml.dist file
````bash
cd config
cp database.yml.dist database.yml
````
Then edit the database.yml file for your puser password
When ready create the database tables and seed the database:
````bash
rake db:schema:load
rake db:seed
This will create an admin user with the email [email protected] and password admin
````
Start the server
````bash
rails s
````
Navigate to http://localhost:3000/
Running the test
================
Currently Your Priorities only has one working test, more tests would be appricated.
This one test is based on Selenium and tests most of the user facing features. To
run the tests you need to open up two terminal windows. You need to have Firefox
installed.
In the first window you start the integration test before running the command in the other window
````bash
rake test:integration
````
In the second window when you see the test database being created from the output start the test server.
If you start it too early then the database cant be dropped for recreation and if you start the server too
then Selenium won't have a server to test against.
````bash
rails s -e test
````
Installing Sphinx search
========================
Please see:
http://pat.github.io/thinking-sphinx/
Cron tasks that are needed
==========================
Idea ranking calculations
````bash
rake schedule:idea_ranker
````
For updating the search index
````bash
rake fs:index
````
Production Deployment on Heroku
===============================
Your Priorities is now setup to be a Heroku app, using S3 and CloudFront for deployment.
Here are the parameters that are used in Heroku config.
Heroku parameters you need to setup yourself:
````bash
AWS_ACCESS_KEY_ID: ----------------------
````
````bash
AWS_SECRET_ACCESS_KEY: ----------------------
````
````bash
CF_ASSET_HOST: ----------------------.cloudfront.net
````
````bash
FACEBOOKER2_API_KEY: ----------------------
````
````bash
FACEBOOKER2_APP_ID: ----------------------
````
````bash
FOG_DIRECTORY: ----------------------
````
````bash
S3_BUCKET: ----------------------
````
````bash
S3_KEY: ----------------------
````
````bash
S3_SECRET: ----------------------
````
````bash
YRPRI_ALL_DOMAIN: 1
````
Below config examples set automatically by the respected services, you can see from this list what heroku additions are needed to run the app:
````bash
ADEPT_SCALE_URL: ----------------------
````
````bash
DATABASE_URL: ----------------------
````
````bash
FLYING_SPHINX_API_KEY: ----------------------
````
````bash
HEROKU_POSTGRESQL_WHITE_URL: ----------------------
````
````bash
MEMCACHIER_USERNAME: ----------------------
````
````bash
PGBACKUPS_URL: ----------------------
````
````bash
REDISTOGO_URL: ----------------------
````
````bash
SENDGRID_USERNAME: ----------------------
````
````bash
AWS_ACCESS_KEY_ID: ----------------------
````
````bash
AWS_ACCESS_KEY_ID: ----------------------
````
Your Priorities is a merge between:
NationBuilder by Jim Gilliam http://www.jimgilliam.com/ and Open Direct Democracy by Róbert Viðar Bjarnason and Gunnar Grimsson http://github.com/rbjarnason/open-direct-democracy