lean-workbench is an analytics tool for early staged startups and NSF Innovation Corps projects.
0.1
lean-workbench works best with Ubuntu 13/14. All installations and deploys must be run from a user with sudo access.
lean-workbench uses a number of open source projects to work properly:
- Python- an awesome scripting language
- Flask - a lean python web framework
- Flask-Sqlalchemy- a Flask SQL database wrapper
- Postgresql- A SQL database
- HTML5Boilerplate
- Yeoman - Frontend management
For developing locally:
./setup-run-dev.sh
Open your browser to http://127.0.0.1:5000/
For the production server:
./setup-deploy.sh
For the cronjob server:
./setup-deploy-cronjob.sh
Copy the crontab contents into
crontab -e
Open the file
/etc/rsyslog.d/50-default.conf
Find the line that starts with:
#cron.*
and uncomment it and restart logging:
sudo service rsyslog restart
Now crontab logs are stored in:
/var/log/cron.log
Crontab program logs are stored in:
/var/mail/root
The following variables must be set in an object called UserConfig in lean_workbench/user_config.py
- SQLALCHEMY_DATABASE_URI - url to a sqlalchemy compatible database
- SECRET - secret for hashing
- SECRET_KEY - key for CSRF
- SECURITY_PASSWORD_SALT - secret for salting passwords
For each of these APIs you want to use
- CRUNCHBASE KEY - API key for crunchbase
- PATH - path to application on server (so it can be added to python path within application)
- WUFOO_API_TOKEN
- WUFOO_ACCOUNT
- ANGELLIST_CLIENT_ID
- ANGELLIST_CLIENT_SECRET
- ANGELLIST_CALLBACK_URL
- TWITTER_APP_KEY
- TWITTER_APP_SECRET
- TWITTER_APP_CALLBACK_URL
- FACEBOOK_APP_ID
- FACEBOOK_APP_SECRET
- GOOGLE_ANALYTICS_KEY_LOCATION
- GOOGLE_ANALYTICS_CLIENT_ID
- GOOGLE_ANALYTICS_KEY_LOCATION
- QUICKBOOKS_SERVER_API_TOKEN
- QUICKBOOKS_SERVER_URL
Except this which must be an environment variable: ALCHEMY_API_KEY
Example lean_workbench/user_config.py
class UserConfig(object):
FACEBOOK_APP_ID = '43543534534'
...
Sass files in the lean_workbench/sass folder are compiled to css in the lean_workbench/sass folder by running
grunt sass
- For angular template variables use
[[ template_variable ]]
Instead of
{{ template_variable }}
For jinga compatiblity so jinga can pass in CSRF tokens.
MIT
Copyright (C) 2014 Jennifer Rubinovitz
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Except as contained in this notice, the name of the author(s) shall not be used in advertising or otherwise to promote the sale, use or other dealings in this Software without prior written authorization from those author(s).