/singlesignon

Primary LanguagePython

Demo Polls Application

Description

This repo is intended for testing a simple polls application which captures answers to poll questions from users. Polls are linked to client and each client can have their own user profile form. The application uses Django's in-built Authentication system (https://docs.djangoproject.com/en/3.2/topics/auth/).

Getting started

Copying the repository

Due to the public nature of forks we suggest you duplicate the repo rather then forking it. You will need to create your own repo e.g. [your_github_username]/singlesignon and then clone this repo eshwaric/singlesignon and push the code into your new one. You can follow the steps for doing this here: https://help.github.com/articles/duplicating-a-repository/

Before proceeding be aware that this exercise assumes you are using a linux machine with pip and venv installed.

To initialize the repository in your base directory execute ./initialize_repo.sh

This script will install Django 3.2 and other libraries required for the application. It also loads a fixture to prepopulate the database with some test data for the application

To start the webserver locally, in your base directory execute ./run-server.sh

To run tests locally, in your base directory execute ./run-tests.sh

Access the application at http://localhost:8000 Login credentials have been shared with you via email

Models description

The application uses 6 models

  1. django.contrib.auth.models.User - stores user details and is an inbuilt Django model provided by the authentication system
  2. polls.Site - stores details about a tenant
  3. polls.Profile - stores additional details for a user. Users can have extra fields and these fields vary for every site based on the profile form. This model refers the ProfilForm and Site model
  4. polls.ProfileForm - Each site can have their own profile form and this model stores the fields for the profile forms. This model has a reference to a Site.
  5. polls.Poll - stores the question for the poll.
  6. polls.Answer - stores answers to the poll and the user who provided the answer. This model has a reference to the Poll and User model.