BES CRM

  Live link can be found here - link \

Table of Contents

• Background
• Mission Statement
• Target Audience
  • User Goals
  • User Stories
  • Requirements and Expectations
  • Wireframes
  • Design Choices
    • Fonts
      • Content
      • Headings
    • Colours
    • Images
  • Structure
    • Models
    • Forms
  • Features
    • Existing Features
    • Features to be implemented
  • Technologies used
    • Languages
    • Libraries, Frameworks and Tools
  • Testing
    • UX Testing
    • Manual Testing
    • Code Validation
    • Bugs
    • Unfixed Bugs
  • Deployment
    • Local Deployment
    • Deployment via Heroku
  • Credits

Background

CRM was created for sales persons of Bohemian Estates with their constant need to be on the move in mind. Therefore mobile first apporach was done. With the most important thing to able to do while with customer, to be able to quickly create a new lead with couple of clicks.

Mission Statement

to create an app which makes life of a sales person easier thanks to its ability to do everything opn the go.

Target audience

employees who could use this app

User goals

1. create update and delete leads
2. quickly be able to do everything on the mobile phone
3. login and logout
4. view own details

User stories

Requirements and Expectations

  Back to Top
 

Wireframes

  Back to Top
 

Design Choices

Fonts

there was no choice of a new font, everythnig was clearly visible with the default one

Colors

link

Colors and contrast validations

contrast1 contrast2

Models

leads

Forms

LeadModelForm fields

• first name
• last name
• description
• phone number
• email

CustomerCretionForm fields

• username
• email
• password1
• password2
• first_name
• last_name

CustomUserEdit excludefields

• password
• last-login
• is_superuser
• groups
• date_joined
• user permissions
• is_active
• is_staff

  Back to Top
 

features

Existing Features

Authentication

The authentication process for the application has three parts.

• Sign Up
• Sign In
• Log out

Sign Up

The signup process requests following required fields from the user:

• Username
• First name
• Last name
• Password
• Password confirmation

Sign In

The sign-in form requires only two fields to be entered.

• Username
• Password

Features to be Implemented

• lead count
• reward input
• follow up feature

  Back to Top
 

Languages

Libraries and Frameworks

Tools

Deployment

This project was created using GitHub and the code was written using Gitpod. This project is also deployed to Heroku with Heroku deployment set to Enable Automatic Deploys. This means that every time that the repository was pushed to, Heroku was updated also.

The live link to the application can be found here

Local Deployment

As Gitpod was the IDE that was used to create the project, the following local deployment steps are specific to Gitpod.

Cloudinary

• Visit Cloudinary by following this link
• Click on the Sign Up For Free button
• When the account is created, you should see the API Environment variable, we will need this for a later process.

GitHub

• Visit Github by following this link

• Create an account or log in

• In the terminal run

pip3 install -r requirements.txt

• In the root directory create a file called env.py and add the following content, the content of these, must match the Config Vars in the Heroku deployment section

import os

os.environ['DATABASE_URL'] = "FROM HEROKU DEPLOYMENT SECTION, DATABASE_URL CONFIG VAR"
os.environ['SECRET_KEY'] = "FROM HEROKU DEPLOYMENT SECTION SECRET_KEY CONFIG VAR"
os.environ['CLOUDINARY_URL'] = "API ENVIRONMENT VARIABLE REMOVE 'CLOUDINARY_URL=' FROM BEGINING"
os.environ['DEVELOP'] = '1'


* Add the env.py file to the .gitignore file to ensure that its contents are not made public

* Migrate the database models with the following command in the terminal

* Create a superuser and set up the credentials with the following command

python3 manage.py createsuperuser

* Run the application locally with the command

python3 manage.py runserver

Deployment via Heroku

• Visit heroku.com

• Create a new account or sign in

• From the dashboard, select New and then Create new app

• Enter an individual app name into the text box, select a region from the dropdown and then press Create app

• A Heroku app has now been created and the Deploy tab is opened.

• Open the Resources tab and in the search bar for Add-ons type Postgres

• Select Heroku Postgres, on the popup, ensure the dropdown is set to Hobby Dev - Free and then Submit Order Form

• Open the Settings tab and then click on the Reveal Config Vars button and the database_url should be populated.

• Fill out the rest of the config vars with the content of the table below by filling out the Key and Value and clicking on Add for each entry

• In the buildpacks section of the settings tab, click on Add Buildpack, select python and then save changes

• Open the Deploy tab

• In the deployment method section, select GitHub and confirm the connection.

• Enter the repo-name into the text box and click Search. When the correct repo appears below, click Connect

• Return to the Gitpod workspace and in the root directory create a file called Procfile

• In the Procfile enter the following line including your project name

web: gunicorn YOUR_PROJECT_NAME.wsgi

• Add and commit to GitHub

git add .
git commit -m "commit message goes here"
git push

• Add your Heroku app URL to ALLOWED_HOSTS in your settings.py file

ALLOWED_HOSTS = ['YOUR_PROJECT_NAME.herokuapp.com', 'localhost']

Code Validation

HTML

CSS

Python

  Back to Top
 

Credits

• Codeinstitute for big support, student care and tutors, thank you
• Simen Daehlin for advice and direction and continual support
• Codemy.com for help on Django

  Back to Top