Skip to content

Readme Documentation #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
gkesavan wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Readme Documentation #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 30 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,33 @@
# iPay

An app that helps you to track your monthly payments

TODO: Add more documentation
Requirements:
Python version:2.6

Installation using virtualenv:

$ curl -O https://raw.github.com/pypa/virtualenv/master/virtualenv.py
$ python virtualenv.py myApp
$ . myApp/bin/activate

Note: with the above activation your prompt would change to notify that you are inside the virtualenv myApp

Installing pip inside the virtualenv:

$ curl https://raw.github.com/pypa/pip/master/contrib/get-pip.py | python

Once the above pip installation is done, clone the github project

$ git clone git@github.com:gkesavan/iPay.git

now that the repo is cloned, lets use pip to install all required modules to start the server
$ cd iPay
$ pip install -r requirements.txt
$ ./manage.py startapp pay # give it any name - I used pay
$ ./manage.py runserver

This would start the ipay app on http://127.0.0.1:8000

enjoy