Planbox

Planbox is a platform for getting the word out about your planning projects. Its beautiful and easy to use interface will help you get your project online in no time.

Features

• Create project
• Quickly and easily edit details
• Timeline of progress

Requirements

Describe the technology stack and any dependencies.

Local Setup

Clone this repo

git clone git@github.com:openplans/planbox.git

Install dependencies

 cd planbox
 virtualenv env
 source env/bin/activate
 pip install -r requirements.txt
 bower install
 cp src/planbox/local_settings.py.template src/planbox/local_settings.py

Start your local server

 src/manage.py runserver

Configure your S3 bucket

This is used for uploading images and attachments. Add a CORS Configuration that roughly matches this:

<?xml version="1.0" encoding="UTF-8"?>
<CORSConfiguration xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
    <CORSRule>
        <AllowedOrigin>http://localhost:8000</AllowedOrigin>
        <AllowedMethod>GET</AllowedMethod>
        <AllowedMethod>PUT</AllowedMethod>
        <AllowedMethod>POST</AllowedMethod>
        <AllowedMethod>DELETE</AllowedMethod>
        <MaxAgeSeconds>3000</MaxAgeSeconds>
        <AllowedHeader>*</AllowedHeader>
    </CORSRule>
</CORSConfiguration>

Note that you will have to add an AllowedOrigin element for each domain your application will run on. You can use wildcard asterisks (*) in the origin if you wish, but it will mean that anyone can write to your bucket.

Deploy to Heroku

Create the app

1. Create a Heroku app for your Hatch git repo heroku apps:create my-app-name
2. Make sure you add the following Heroku Add-ons

• Postgresql
• Rediscloud (or your favorite Redis add-on)
• Heroku Scheduler

Next thing

TBD

Supported Browsers

Desktop

• Chrome (latest)
• Firefox (latest)
• Safari (latest)
• Internet Explorer (8-10)

Mobile

• IOS Safari 6+
• Android Browser 4+
• Chrome

Google Analytics configuration

Planbox stores the request domain information using two additional variables (dimensions):

• Dimension 1 : Domain
• Dimension 2 : Root Path

Refer to the Google Analytics documentation on setting up custom dimensions to configure your account appropriately.

Copyright

Copyright (c) 2014 OpenPlans