https://github.com/AamAadmiParty/cleansweep

Volunteer & Campaign Management System
https://github.com/AamAadmiParty/cleansweep

Last synced: 3 months ago
JSON representation

Volunteer & Campaign Management System

• Host: GitHub
• URL: https://github.com/AamAadmiParty/cleansweep
• Owner: AamAadmiParty
• License: other
• Created: 2014-06-16T19:58:50.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2020-03-28T03:31:49.000Z (almost 5 years ago)
• Last Synced: 2024-07-31T23:39:39.403Z (6 months ago)
• Language: JavaScript
• Homepage:
• Size: 1.28 MB
• Stars: 40
• Watchers: 11
• Forks: 21
• Open Issues: 40
• Metadata Files:
  • Readme: Readme.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-flask - cleansweep - Volunteer & Campaign Management System (Built with Flask)
• awesome-flask - cleansweep - Volunteer & Campaign Management System (Built with Flask)
• awesome-flask - cleansweep - Volunteer & Campaign Management System (Built with Flask)

README

        
Cleansweep

==========

[![Build Status](https://travis-ci.org/AamAadmiParty/cleansweep.svg?branch=master)](https://travis-ci.org/AamAadmiParty/cleansweep)

[![Slack](http://cleansweep-slack.herokuapp.com/badge.svg)](http://cleansweep-slack.herokuapp.com)

Requirements

------------

A Linux (or Mac OS X) node with the following software installed. Ubuntu 14.04 is preferred.

* PostgreSQL 9.3 database server

* Python 2.7

* Git

* python virtualenv

Installing them on Ubuntu/Debian:

    $ sudo apt-get install postgresql-9.3 postgresql-server-dev-9.3 python-dev python-virtualenv git

How to Setup

------------

* Clone the repository

        $ git clone https://github.com/AamAadmiParty/cleansweep.git

        $ cd cleansweep

* setup virtualenv

        $ virtualenv . 

* activate the virtualenv

        $ source bin/activate

* Install dependent python packages

        $ pip install -r requirements.txt

* Create database user

        

        $ sudo -u postgres createuser -s $USER

* create database for cleansweep

    

        $ createdb cleansweep 

* Init the app by adding you as admin. It'll prompt you for your name, email 

  and phone number.

        $ python manage.py init

        ...

        Your Name: ______

        E-mail address: ______

        Phone: ______

    

* run the webapp

        python manage.py runserver

Visit the website at:

Getting Started with Development

--------------------------------

Look at the [helloworld module][] to learn about how to a component works in

cleansweep.

[helloworld module]: https://github.com/AamAadmiParty/cleansweep/tree/master/cleansweep/helloworld

LICENSE

-------

This software is licensed under AGPLv3.