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
This commit is contained in:
parent
5a0143a698
commit
46fb071544
28
README.rst
28
README.rst
@ -33,3 +33,31 @@ 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
|
||||
|
Loading…
x
Reference in New Issue
Block a user