OpenStack Task Tracking API

Go to file

James E. Blair 46fb071544 Add info about how to run to README Add instructions on how to run this program and also mention that there is a webclient in another repo. Change-Id: I610715249b1466c63507e9e428ea3833ac295309		2014-01-30 07:43:49 -08:00
doc/source	Update documentation	2014-01-27 18:54:18 +04:00
etc	Add a sample config file	2014-01-23 16:09:22 +04:00
storyboard	Merge "API tests for rest"	2014-01-28 11:04:07 +00:00
.gitignore	Add a sample config file	2014-01-23 16:09:22 +04:00
.gitreview	Add .gitreview file.	2013-07-18 12:03:46 +02:00
.testr.conf	API tests for rest	2014-01-23 17:23:58 +04:00
CONTRIBUTING.rst	Update documentation	2014-01-27 18:54:18 +04:00
LICENSE	Initial import	2013-07-01 18:09:56 +02:00
MANIFEST.in	Introducing basic REST API	2014-01-22 11:37:54 -08:00
README.rst	Add info about how to run to README	2014-01-30 07:43:49 -08:00
babel.cfg	Add SQLalchemy database model	2014-01-13 18:52:47 +04:00
manage.py	Initial import	2013-07-01 18:09:56 +02:00
openstack-common.conf	Introducing basic REST API	2014-01-22 11:37:54 -08:00
requirements.txt	Introducing basic REST API	2014-01-22 11:37:54 -08:00
setup.cfg	Don't try to install file that doesn't exist	2014-01-27 08:26:26 -08:00
setup.py	Update setup code past d2to1	2013-09-25 12:06:40 -04:00
test-requirements.txt	Add tests for Alembic migrations	2014-01-22 10:54:32 -08:00
tox.ini	API tests for rest	2014-01-23 17:23:58 +04:00

README.rst

Storyboard

Storyboard is a task tracker for OpenStack.

Project Resources

Project status, bugs, and blueprints are tracked at:

http://storyboard.openstack.org

Source code can be found at:

https://git.openstack.org/cgit/openstack-infra/storyboard/

Documentation can be found here:

http://ci.openstack.org/storyboard/

Additional resources are linked from the project wiki page:

https://wiki.openstack.org/wiki/StoryBoard

Anyone wishing to contribute to an OpenStack project should find plenty of helpful resources here:

https://wiki.openstack.org/wiki/HowToContribute

All OpenStack projects use Gerrit for code reviews. A good reference for that is here:

https://wiki.openstack.org/wiki/GerritWorkflow

Getting Started as a Developer

Storyboard has two components: this API server, and the Javascript-based web client. To start the API server, make sure you have the following packages installed locally:

libpq-dev
libmysqlclient-dev

Then run:

mysql -u $DB_USER -p $DB_PASSWORD -e 'DROP DATABASE IF EXISTS storyboard;'
mysql -u $DB_USER -p $DB_PASSWORD -e 'CREATE DATABASE storyboard;'
cp ./etc/storyboard.conf.sample ./etc/storyboard.conf

Edit ./etc/storyboard.conf and set the connection parameter in the [database] section. Then run:

tox -e venv "storyboard-db-manage --config-file ./etc/storyboard.conf upgrade head"
tox -e venv "storyboard-api --config-file ./etc/storyboard.conf"

Then to use the web client, clone the repo and follow the instructions in the README:

git clone https://git.openstack.org/openstack-infra/storyboard-webclient