Diverspect

Introduction

A link to our website can be found here

UX

Overview

Diverspect is an online forum where users can provide feedback and suggestions to companies to make the workplace more accessible. It can be a forum for people from all walks of life in any industry where they need their voice heard about what can be done to improve inclusivity in the workplace. User cna sign up for an account, post a comment, edit and delete their comments and read comments added by other users.

Goals -

Wireframes -

We have produced a mock up of the websites pages. You can view them here

Design -

Design Process -

Strategy Plane -
Scope Plane -
Structure Plane -

Database Structure -

Skeleton Plane -
Surface Plane -

Colour Pallette -

Blue/ Yellow/ Green / Red

Font -

User Stories

Target Audience -

As a Site User -

As a Site Superuser -

As a Developer -

Features

Responsive on all device sizes.
Interactive elements.

Existing Features -

Features Visiable across All Pages -

Features Visiable on each page -

Features left to Implement -

Bugs and Fixes Implemented after Testing -

Technologies Used

Backend Technologies -

Gunicorn 20.0.4: Gunicorn ‘Green Unicorn’ is a Python WSGI HTTP Server for UNIX. The Gunicorn server is broadly compatible with various web frameworks, simply implemented, light on server resources, and fairly speedy. https://docs.gunicorn.org/en/stable/
Pillow 4.3.0: The Python Imaging Library adds image processing capabilities to your Python interpreter. This library provides extensive file format support, an efficient internal representation, and fairly powerful image processing capabilities. https://pillow.readthedocs.io/en/stable/handbook/overview.html
Psycopg2 2.8.5: Psycopg is the most popular PostgreSQL database adapter for the Python programming language. Its main features are the complete implementation of the Python DB API 2.0 specification and the thread safety. https://pypi.org/project/psycopg2/
boto3 1.14.5: Boto is the Amazon Web Services (AWS) SDK for Python. It enables Python developers to create, configure, and manage AWS services, such as EC2 and S3. https://boto3.amazonaws.com/v1/documentation/api/latest/index.html

Languages -

HTML5, or Hyper Text Markup Language: Used to construct the page withn this app -
https://developer.mozilla.org/en-US/docs/Web/HTML
CSS3, or Cascading Style Sheets: Used to style the various elements on the app's pages via coloring, fonts, spacing, etc. - https://www.w3.org/Style/CSS/Overview.en.html
Javascript: A programming language - https://www.javascript.com/
JQuery: A programming language - https://jquery.com/
Python3: A programming language - https://www.python.org/
Jinja: A programming language - https://jinja.palletsprojects.com/
Bson and Json: A computer data interchange format - https://www.mongodb.com/json-and-bson

Libraries -

API's -

Django: A web framework - https://www.djangoproject.com/

Databases -

Postgres: Open Source Database - https://www.postgresql.org/
sqLite3: SQL Database Engine - https://www.sqlite.org/

Tools -

Gitpod: An online IDE also used for creating & saving code that runs in a browser, it does not have to be installed on your PC - https://www.gitpod.io/
Git: A version control system for tracking changes in source code during software development - https://git-scm.com/
Github: A company that provides hosting for software development version control using Git. It is a subsidiary of Microsoft - https://github
Heroku: An application platform. allowing users to build, run and operate applications - https://www.heroku.com
Django Secret Key Generator: Generates Django secret keys - https://miniwebtool.com/django-secret-key-generator/
Chrome DevTools: A set of web developer tools built directly into the Google Chrome browser. I used these tools constantly thoughout the development cycle - https://developers.google.com/web/tools/chrome-devtools
W3C Markup Validation Service: Used to run all html and css code through a validation process looking for errors - https://validator.w3.org/ https://jigsaw.w3.org/css-validator/validator
Pep8: Python Validator used to run all python code through to look for errors - http://pep8online.com/
JSHint: Javascript Validator used to run all JS code through looking for errors - https://jshint.com/
Free Formatter: A HTML formatter that Formatted my HTML 2 spaces per indent - https://www.freeformatter.com/

Testing

We carried out substantial testing on the websites pages and links. You can see the results of the tests here

Validation of Code Testing -

HTML -

All Pages tested using W3C HTML Validator.

CSS -

All Pages tested using W3C CSS Validator.

Javascript -

All JS and JQuery tested using JSHint Javascript Validator.

Python -

All Python tested using PEP8 Python Validator.

Note: python3 -m flake8 was run and all the errors and warnings associated with my own code, were fixed. Line to long errors within the code generated by Django and code from the migrations were left as developers shouldn't need to touch them. Errors left within our own code are -

Deployment

This website was developed in Gitpod and pushed to the remote repositories, GitHub and Heroku. The live page is hosted on Heroku.

Used Commands during Deployment -

git add . - To add files to staging area.
git commit -m "message here" - To commit the files.
git push - To push the committed files to the origin master branch on github.
git push heroku master - To push the commited files to the origin master branch on heroku.
git status - To see the current state of the files.
python3 manage.py migrate - Runs migrations.
python3 manage.py create superuser - Creates Superuser.
python3 manage.py dumpdata - To create json data files.
export DATABASE_URL= "your value from heroku" - To connect Gitpod to Postgres.
python3 manage.py loaddata - Loads the dumps into Postgres.

Hosting on Heroku -

In order to successfully deploy the app, the following steps were taken:

Log into your Heroku account, create new app.
Choose app name and closest region.
On Resources tab, provision Heroku Postgres.
Back in gitpod, install the following via these commands:
- pip3 install dj database url
- pip3 install psycopg2 binary
Freeze the requirements to update the requirements.txt file. This makes sure Heroku installs all apps when deployed:
- pip3 freeze > requirements.txt
To get the database setup, go to settings.py and import dj_database_url.
In databases settings, comment out default configuration and replace the default database with a call to dj_database_url.parse, and give it the database URL from Heroku stored in your config variables (under the app settings tab).
Now run all migrations with:
- python 3 manage.py migrate
Then create a superuser with:
- python3 manage.py create superuser
Back in settings.py remove the Heroku database config, and uncomment the original so our database URL doesn't end up in version control.
Then commit to github.
Using an if statement in settings.py, to allow access to Postgres when running on Heroku, where database URL environment variable is defined, otherwise connecting to sqlite.
Install unicorn, which will act as our webserver, then freeze that into requirements.txt:
- pip3 install gunicorn
- pip3 freeze > requirements.txt
Create Procfile, enter the following to tell Heroku to create a web dyno, which will run unicorn and serve our django app:
- web: gunicorn APP_NAME.wsgi:application
Temporarily disable collectstatic.
Add the hostname of our Heroku app to allowed hosts in settings.py, and localhost:
- ALLOWED_HOSTS = ['YOUR-APP-NAME.herokuapp.com', 'localhost']
Add/commit changes to github.
To deploy to Heroku, enter (you may need to initialize your Heroku git remote if you created your app on the website rather than the CLI):
- git push heroku master
To automatically deploy on Heroku when committing to github - on your Heroku dashboard go to Deploy > Github, search for your repository and click Connect.
Click Enable Automatic Deploys.
Add a new secret key in your Heroku Config Vars (you can use an online Django secret key generator to do this).
Now you can replace the secret key in settings.py with a call to get this from the environment.
Commit/push these changes to github.

Forking the GitHub Repository -

By forking the GitHub Repository we make a copy of the original repository on our GitHub account to view and/or make changes without affecting the original repository by using the following steps...

Log in to GitHub and locate the GitHub Repository
At the top of the Repository (not top of page) just above the "Settings" Button on the menu, locate the "Fork" Button.
You should now have a copy of the original repository in your GitHub account.

Running this Project Locally -

You will need to install the following to run this locally:

An IDE
Python3 to run the application
PIP to install all app requirements
Django
SQlite or Postgres Databases
GIT for cloning and version control

To run this code on your local machine, you would go to my respository at https://github.com/Gwen-Bradbury/trust-in-soda-hackathon and on the home page on the right hand side just above all the files, you will see a green button that says, "Clone or download", this button will give you options to clone with HTTPS, open in desktop or download as a zip file. To continue with cloning, you would;

Open Git Bash
Change the current working directory to the location where you want the cloned directory to be made.
Type git clone, and then paste this URL; https://github.com/Gwen-Bradbury/trust-in-soda-hackathon.git Press Enter. Your local clone will be created.

For more information about the above process; https://help.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository

Files

README.md

Latest commit

History