Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Tabatha Memmott committed Feb 29, 2016
1 parent f501ee3 commit 40c1cc7
Showing 1 changed file with 30 additions and 21 deletions.
51 changes: 30 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,43 +2,52 @@ AngularJS Module for [Django REST Auth](https://github.com/Tivix/django-rest-aut
==================================================================================

To setup this module as a boilerplate project...
------------------------------------------------
---------------------------------------------------

First, clone the repository.
##### First, clone the repository:
`git clone [email protected]:Tivix/angular-django-registration-auth.git`

Change your directory to the cloned project.
##### Change your directory to the cloned project:
`cd angular-django-registration-auth`

Then install the project prerequisites.
##### Then, install the project prerequisites:
`npm install; bower install;`

In app/scripts/services/djangoAuth.js, customize API_URL and use_session to meet your project's requirements.
##### Customize API_URL and use_session to meet your project's requirements:
Go to `app/scripts/services/djangoAuth.js`

To integrate this module into an existing project...
----------------------------------------------------
###### If using django-rest-auth demo, check out the docs for a list of endpoints:
http://django-rest-auth.readthedocs.org/en/latest/api_endpoints.html

First, clone the repository.
`git clone [email protected]:Tivix/angular-django-registration-auth.git`
##### Then, serve the Angular Django Registration Auth Demo:
`grunt serve`

The contents of the app/scripts folder can be copied to your own project. Exclude controllers and app.js if you do not intend to use the default views/routes. (This will provide API access from the djangoAuth module only.)
To integrate this module into an existing project...
-------------------------------------------------------

Please note: you will need to include dependencies from bower.json to support the default views/controllers. They require bootstrap and its dependencies to function correctly.
##### First, clone the repository:
`git clone [email protected]:Tivix/angular-django-registration-auth.git`

If you intend to use the default views/routes, please also copy the contents of app/views to your own views folder.
The contents of the `app/scripts` folder can be copied to your own project.
*Exclude controllers and app.js if you do not intend to use the default views/routes. (This will provide API access from the djangoAuth module only.)*

Inject the angularDjangoRegistrationAuthApp into your own module.
##### Inject the angularDjangoRegistrationAuthApp into your own module.

Inject the djangoAuth service into any controllers which you need programmatic access to Django REST Auth.
##### Inject the djangoAuth service into any controllers in which you need programmatic access to Django REST Auth.

In app/scripts/services/djangoAuth.js, customize API_URL and use_session to meet your project's requirements.
Alternatively, you can change these settings from a controller by changing the djangoAuth.API_URL and djangoAuth.use_session variables.
##### Customize API_URL and use_session to meet your project's requirements:
Go to `app/scripts/services/djangoAuth.js`
*Alternatively, you can change these settings from a controller by changing the djangoAuth.API_URL and djangoAuth.use_session variables.*

Todo
----
###### Please note:
you will need to include dependencies from bower.json to support the default views/controllers. *They require bootstrap and its dependencies to function correctly.*
If you intend to use the default views/routes, copy the contents of app/views to your own views folder.

Todo: We encourage contributions for these aims...
-----------------------------------------------------

Add support for JWT (JSON web tokens)
- [ ] Add support for JWT (JSON web tokens)

Better support for Bower and Grunt
- [ ] Better support for Bower and Grunt

Pick a better name for the module :\
- [ ] Pick a better name for the module?

0 comments on commit 40c1cc7

Please sign in to comment.