Ushahidi Sweeper Application (v2)
PHP Other
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
application
install/sql
modules
plugins
system
themes/default
.gitignore
.gitmodules
.htaccess
LICENSE
README.md
favicon.ico
index.php

README.md

Diagram

Sweeper

Sweeper is part of the SwiftRiver initiative at Ushahidi. SwiftRiver's aim is to democratize access to the tools used to make sense of realtime data. This app is designed to allow users to sweep through data feeds quickly, using conditional filters and views.

Support

General Overview

Sweeper is broken down into projects, stories and items. The application has a feed builder that generates the item stream. Items can then be clustered together to form stories. Sweeper can extract the following entities from the content in items:

  • Sources
  • Tags
  • Dates
  • Places
  • Links
  • Attachments (jpg,gif,png,pdf,mov etc..)

Diagram

Requirements

Installation

  • Download and extract Sweeper

    To unzip/extract the archive on a typical Unix/Linux command line:

    tar -xvf Sweeper-xxxx.tar.gz
    

    or in the case of a zip file:

    unzip Sweeper-xxxx.zip
    

    This will create a new directory Sweeper-xxxx containing all the Sweeper platform files and directories - Move the contents of this directory into a directory within your webserver's document root or your public HTML directory.

  • Ensure the following directories are writable (i.e. have their permission values set to 777)

    • application/config
    • application/cache
    • application/logs

    On Unix/Linux, you can change the permissions as follows:

    cd path-to-webserver-document-root-directory
    chmod -R 777 application/config
    chmod -R 777 application/cache
    chmod -R 777 application/logs
    
    NOTE: The process of configuring file permissions is different for various operating systems. Here are some helpful links about permissions for the Windows (http://support.microsoft.com/kb/308419) and Unix (http://www.washington.edu/computing/unix/permissions.html) operating systems.
  • Create the Sweeper database

    Sweeper stores all its information in a database. You must therefore create this database in order to install Sweeper. This is done as follows:

    mysqladmin -u '[username]' -p create '[databasename]'
    

    MySQL will prompt for the password for the database password and then create the initial database files. Next, you must log in and set the database access rights:

    mysql -u 'username' -p
    

    Again, you will be prompted for the 'username' database password. At the MySQL prompt, enter the following command:

    GRANT SELECT, INSERT, DELETE, UPDATE, CREATE, DROP, ALTER, INDEX on 'databasename'.* 
    TO 'username'@'localhost' IDENFIFIED BY 'password';
    

    Where:

    • 'databasename' is the name of your database
    • 'username@localhost' is the name of your MySQL account
    • 'password' is the password required for that username
    NOTE: Your account must have all the privileges listed above in order to run Sweeper on your webserver.
  • Sweeper doesn't yet have an installer. Until then, please import the required database tables with the following command:

    mysql -u '[username]' -p '[password]' '[database]' < install/sql/sweeper.sql

  • Finally, to access Sweeper, the default username and password are sweeperadmin/password

Credits

Contributors

  • David Kobia
  • Heather Ford
  • Chris Blow
  • Ed Bice
  • Anas Qtiesh

Organizations