Lokalny kupon DocumentationRelease 1.0

Miroslaw Czechorowski

Jan 27, 2017

Contents:

1 Requirements 3

2 Instalation 5

3 Features 7

4 Use case 9

5 Database diagram 11

6 Permissions 13

7 License 15

8 Author 17

9 Indices and tables 19

i

ii

Lokalny kupon Documentation, Release 1.0

Simple Django CMS with set of the open source applications. Page lets you add a coupon with a description andphoto. Furthermore, you can add events related to the theme of the page. The application provides user registration,social network authentication, send e-mail by contact page and subscribe to the newsletter. Additionally logged-inuser has rights to remove or edit coupons and events. From Django Admin page you can manage users, newsletters,coupons and events.

Screnshoots:

Contents: 1

Lokalny kupon Documentation, Release 1.0

2 Contents:

CHAPTER 1

Requirements

This project use applications listed below:

• ‘admin_tools’,

• ‘admin_tools.theming’,

• ‘admin_tools.menu’,

• ‘admin_tools.dashboard’,

• ‘django.contrib.admin’,

• ‘django.contrib.auth’,

• ‘django.contrib.contenttypes’,

• ‘django.contrib.sessions’,

• ‘django.contrib.messages’,

• ‘django.contrib.staticfiles’,

• ‘blog’,

• ‘django_nvd3’,

• ‘djangobower’,

• ‘django_extensions’,

• ‘admin_tools_stats’,

• ‘events’,

• ‘contact_form’,

• ‘tinymce’,

• ‘django.contrib.sites’,

• ‘allauth’,

• ‘allauth.account’,

3

Lokalny kupon Documentation, Release 1.0

• ‘allauth.socialaccount’,

• ‘allauth.socialaccount.providers.facebook’,

• ‘allauth.socialaccount.providers.google’,

• ‘sorl.thumbnail’,

• ‘newsletter’,

• ‘django_comments’,

All requirements used to run this project you can find in requirements.txt file, in main directory of project.

4 Chapter 1. Requirements

CHAPTER 2

Instalation

You can simply clone git repository

$ git clone https://github.com/MiroslawCzechorowski/DjangoProjekt

Than simply edit project to your needs.

5

Lokalny kupon Documentation, Release 1.0

6 Chapter 2. Instalation

CHAPTER 3

Features

This CMS provides you:

• users (login/registration/logout),

• newsletter managment (subscribe,unsubcribe, read messages, check archives),

• error reporting to console (70%),

• contact form,

• manage events (basic CRUD),

• manage coupons (basic CRUD),

• integration with Facebook and Google+,

7

Lokalny kupon Documentation, Release 1.0

8 Chapter 3. Features

9

Lokalny kupon Documentation, Release 1.0

CHAPTER 4

Use case

10 Chapter 4. Use case

CHAPTER 5

Database diagram

The file contains much data, so if you would like to see it, you can do it here: HTML file

11

Lokalny kupon Documentation, Release 1.0

12 Chapter 5. Database diagram

CHAPTER 6

Permissions

Anonymous user permissions:

• see content of events,

• see content of coupons,

• un/subscribe to the newsletter,

• send message with contact form,

Loged(registered) in user permissions:

• anonymous user permissions,

• CRUD operations at events,

• CRUD operation at coupons,

Loged in superuser permissions:

• registered user,

• access to Django admin panel,

• write messages for newsletter,

• manage newsletters,

• CRUD operations at users,

13

Lokalny kupon Documentation, Release 1.0

14 Chapter 6. Permissions

CHAPTER 7

License

TO DO

15

Lokalny kupon Documentation, Release 1.0

16 Chapter 7. License

CHAPTER 8

Author

Miroslaw Czechorowski

17

Lokalny kupon Documentation, Release 1.0

18 Chapter 8. Author

CHAPTER 9

Indices and tables

• genindex

• modindex

• search

19