Skip to content

Commit

Permalink
Merge pull request #64 from colab/update_readme
Browse files Browse the repository at this point in the history
Update development environment stuff in README
  • Loading branch information
seocam committed Sep 4, 2015
2 parents eae398a + 77fd4a8 commit 2a30ff9
Showing 1 changed file with 44 additions and 8 deletions.
52 changes: 44 additions & 8 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,18 @@ First install the dependencies and than the project it self:

.. code-block::
pip install -r requirements.txt
pip install .
pip install -e .
Development environment
-----------------------

You must install vagrant to set up the development environment. With vagrant available you should run:

.. code-block::
vagrant up
During the process you should choose the vagrant box that you want to use. In the end you should have a virtual machine with development environment set up.



Expand All @@ -60,20 +70,25 @@ Running Colab

To run Colab with development server you will have to:

1- Create the example configuration file:
1- Log in virtual machine:

.. code-block::
colab-admin initconfig > /etc/colab/settings.py
vagrant ssh
2- Edit the configuration file. Make sure you set everything you need including **database** credentials.
2- Use colab virtualenv:

.. code-block::
workon colab
3- Run the development server:

.. code-block::
colab-admin runserver 0.0.0.0:8000
Now you can access colab in your browser via http://localhost:8000

**NOTE**: In case you want to keep the configuration file else where just set the
desired location in environment variable **COLAB_SETTINGS**.
Expand All @@ -84,12 +99,33 @@ About test
How to write a test
--------------------
Inside of each folder on /vagrant/colab/<folder> you can create a folder called
"tests", and inside of it implements the code for test each file.
"tests" and inside of it implements the code for test each file. Remember that you should create __init__.py file.

How to run the tests
--------------------

Follow the steps below:

* Go to vagrant/colab/
* run: ./runtests.sh
1- Log in virtual machine:

.. code-block::
vagrant ssh
2- Use colab virtualenv:

.. code-block::
workon colab
3- Enter into colab source code directory:

.. code-block::
cd /vagrant
4- Run tests with setup.py:

.. code-block::
python setup.py test

0 comments on commit 2a30ff9

Please sign in to comment.