Skip to content

Commit

Permalink
update readme file
Browse files Browse the repository at this point in the history
  • Loading branch information
Jpadilla1 committed Jul 13, 2014
1 parent 9b91879 commit b4e31f2
Showing 1 changed file with 20 additions and 2 deletions.
22 changes: 20 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,22 @@
chatrooms
Chatrooms
=========

Simple chat app made with django
Chatrooms API made with Django.

##Installation
==============

NOTE: This project assumes that you have python 2.7 installed on your machine.

First you will need redis to run this project. If you do not have redis installed you can get at http://redis.io/download for your OS. Then you will need to start the redis server. Details on the redis site.

Then create a new virtual environment, activate it and `pip install -r requirements.txt`

Next run `python manage.py syncdb` and `python manage.py runserver`.

Go to http://localhost:8000/ in your browser and you will see the demo running.

##TODO
======

Finish API and Documentation

0 comments on commit b4e31f2

Please sign in to comment.