Skip to content

Latest commit

 

History

History
29 lines (18 loc) · 1.64 KB

README.md

File metadata and controls

29 lines (18 loc) · 1.64 KB

Microauth

Build Status Coverage Status

Microauth is the authentication module for the microserv project. We use OAuth2 as authentication, with great help from oauthlib and django-oauth-toolkit.

Getting started

TL;DR: This is a regular Django project, so follow the regular Django startup guides for getting the project running.

Starting development

Let's make sure we're up to date with upstream git repository, install any new requirements and migrate any database changes.

  1. [clone|fetch|pull|merge] this repository
  2. Install project dependencies from requirements.txt
  3. python manage.py migrate
  4. cd apps/authentication/static/js/, npm install . - This installs node modules required for transpiling ReactJS code.
  5. Make sure the requirements specified in package.json (in the project root folder) is in your PATH. (Quickfix: install them globally by npm install -g <packages>)
  6. python manage.py runserver (Yes, it's step #10 - that makes it easy to add steps in before it without renaming the step number)

How to use this application

Let's move this section to the Wiki whenever we get enough content in it?

Adding a new Client (Application)

TODO. For now, read https://django-oauth-toolkit.readthedocs.org/en/latest/tutorial/tutorial_01.html.