Add a proper README file

parent f5461e76
My super web application
========================
A simple web application: URL follower
======================================
I'll write more about this when it's ready...
This is a simple web application which allows users to generate
short tracked URLS from longer ones. A short URL redirects to
the original URL, when followed. It is tracked in the sense that
a counter is incremented, every time the URL is followed.
Installation
------------
Assuming you have a working Python 2.x and `virtualenv`, clone
the repository and then type:
```sh
virtualenv --no-site-packages venv
source venv/bin/activate.csh
pip install -r requirements.txt
```
Then prepare the database:
```sh
python manage.py migrate
```
To deploy the server:
```sh
python manage.py runserver
```
and then go to [http://localhost:8000/](http://localhost:8000/).
Step by step
------------
A better description of how to arrive here one step at a time,
from scratch, is found in the README file in branch `prepare`.
Otherwise, just follow the commits, in exactly the order we
showed them in the lab on Monday, June 15, 2015.
---
Enjoy...
Nikos Papaspyrou
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment