README.md

AngularJS Module for Django REST Auth

To setup this module as a boilerplate project...

First, clone the repository:

git clone [email protected]:Tivix/angular-django-registration-auth.git

Change your directory to the cloned project:

cd angular-django-registration-auth

Then, install the project prerequisites:

npm install; bower install;

Customize API_URL and use_session to meet your project's requirements:

Go to app/scripts/services/djangoAuth.js

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

Then, serve the Angular Django Registration Auth Demo:

grunt serve

To integrate this module into an existing project...

First, clone the repository:

git clone [email protected]:Tivix/angular-django-registration-auth.git

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 djangoAuth service into any controllers in which you need programmatic access to Django REST Auth.

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.

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)

• Better support for Bower and Grunt

• Pick a better name for the module?