GitXplorerGitXplorer
c

referly

public
2 stars
0 forks
0 issues

Commits

List of commits on branch master.
Unverified
d985b8fa36be0d565bc2bf2b86546729e9150565

Update README.rst

cchhantyal committed 10 years ago
Unverified
0215a7039ac70a95d256ff65014f8148fcfe9d7b

Merge pull request #4 from chhantyal/develop

committed 11 years ago
Unverified
e502621eb0bea9b3da1c561b04283347901702f4

add page link after referral addition

committed 11 years ago
Unverified
6c038c4daaa22bc6387cf7b57e669afa01a4c3fb

Merge pull request #3 from chhantyal/develop

committed 11 years ago
Unverified
0afbe1728873eac858b7bd1f5587aefb22d648fb

link landing page

committed 11 years ago
Unverified
1f12484b01ffc056cdad3c2b37f45f26132ea6f2

fix edit link after referral creation

committed 11 years ago

README

The README file for this repository.

Referly

An awesome referral app http://referly.herokuapp.com

Developer Installation

For getting this running on your local machine:

  1. Set up a virtualenv.

  2. Install all the supporting libraries into your virtualenv::

    pip install -r requirements/local.txt

  3. Install Grunt Dependencies.

    npm install

  4. Run development server. (For browser auto-reload, use Livereload_ plugins.)

    grunt serve

Usage

JSON fixtures is used to generate test data. For login use: username: timlee and password: timlee

REST API

django-rest-framework is used for REST API.

  1. /apiv1/referrals/ - API endpoint for list of referrals. GET, POST, HEAD, OPTIONS are allowed http methods.

  2. /apiv1/referral/{{referral_id}} - API endpoint for particular referral. referral_id must provided. GET, PUT, PATCH, DELETE, HEAD, OPTIONS http methods are allowed.

  3. /apiv1/user/{{username}} - API endpoint for an user. GET, HEAD, OPTIONS are allowed.