This is a presentation website for Milestone Project three with Code Institute. This project will focus on data centric development utilising tools such as MongoDb.
The Upshot is a website for a local film club. Users will be able to create a profile, log in, read reviews, search for films by title and upload their own content to the site.
-
-
- As a First Time Visitor, I want to learn about The Upshot and what they do.
- As a First Time Visitor, I want to be able to search the film content on the site.
- As a First Time Visitor, I want to see what social media following they have.
-
- As a Returning Visitor, I want to create a user account.
- As a Returning Visitor, I want to find a specific film to read the reviews.
- As a Returning Visitor, I want see my profile page.
-
- As a Frequent User, I want to upload my own reviews to the website.
- As a Frequent User, I want to check for the latest reviews posted by other users.
- As a Frequent User, I want to sign up to the Newsletter so that I can hear about film news and any upcoming events.
-
-
-
- The two main colours used are Black and White, keeping in tone with the filmic aesthetic. the site is colourful from the content being uploading by the users so the backgrounds are kept neutral to not create to much noise on the page.
-
- The primary font used is Oswald, this clean crisp modern font looks great black on white, is easy to read and in keeping with the modern, stylish feel of the site.
-
- The imagery will be primarily images from each of the films posted in the database. The banner image was created by myself using Canva.
-
-
Responsive on all device sizes
-
Interactive elements
-
Ability to create, locate, display, edit and delete records.
-
Data Model.
- Bootstrap 4.4.1:
- Bootstrap was used to assist with the responsiveness and styling of the website.
- Materialise:
- Materialise was used as the frame work for different areas such as the nav bar and my reviews collapsible menu.
- Google Fonts:
- Google fonts were used to import the 'Titillium Web' font into the style.css file which is used on all pages throughout the project.
- Font Awesome:
- Font Awesome was used on all pages throughout the website to add icons for aesthetic and UX purposes.
- jQuery:
- jQuery came with Bootstrap to make the navbar responsive but was also used for the smooth scroll function in JavaScript.
- Git
- Git was used for version control by utilizing the Gitpod terminal to commit to Git and Push to GitHub.
- GitHub:
- GitHub is used to store the projects code after being pushed from Git.
- Canva:
- Canva was used to create the logo, resizing images and editing photos for the website.
- Balsamiq:
- Balsamiq was used to create the wireframes during the design process.
- MongoDB:
- MongoDB was used to create the database.
- Heroku was used to deploy the application.
The W3C Markup Validator and W3C CSS Validator Services were used to validate every page of the project to ensure there were no syntax errors in the project.
HTML Validator As jinga was used in the HTML this file was tested by viewing the Page Source and then copying the code into the validator via direct input.
Google Lighthouse Score test View lighthouse Results
The performance score is lower we would liek to see here but on further review this is becuase the images are sourced via linkes from third party sites and not actually affecting the performance of our site.
Email to personal account testing newsletter subscription
-
As a First Time Visitor, I want to learn about The Upshot and what they do.
- Upon entering the site, users are automatically greeted with a clean and easily readable navigation bar to go to the page of their choice. Underneath there is a Hero Image followed by text inviting users to log in our create and account. 2. The footer contains an About Us section to learn more about the organisation.
- The pages and blocks of text were kept minimal to make it very clear what the site represents.
-
As a First Time Visitor, I want to be able to search the film content on the site.
- The site has been designed to be fluid and never to entrap the user. At the top of each page there is a clean navigation bar, each link describes what the page they will end up at clearly.
- The most recent reviews are front and centre on the home page and reviews can be read by just clicking on the image. the search bar allows users to type in any film they are looking for.
- The users profile page keeps a visible list fo their uploaded content.
-
As a First Time Visitor, I want to see what social media following they have.
- Links to all The Upshots social media pages is visible in the footer.
-
-
As a Returning Visitor, I want to create a user account.
- The main navigation bar and the text under the hero image include links for new users to navigate to the create an account page. 2.Once a username and password has been chosen, users will redirect to their own profile page.
-
As a Returning Visitor, I want to find a specific film to read the reviews.
- The home page contain a search bar that will allow users to type in the film title they are looking for and search the entire database. If a result is found, a film card will open under the search bar. If not, a flash message of 'no results found' will be displayed.
-
As a Returning Visitor, I want to see my profile page.
- Once the returning user creates the account. They will be redirected to their profile page and then going forward everytime they log in they will redirect to their profile page.
-
-
-
As a Frequent User, I want to upload my own reviews to the website
- Users who are logged in will see a new navigation bar that includes 'upload your review' where they can add their own content. Once added, this will live on their profile page and can be edited, deleted when they wish.
-
As a Frequent User, I want to sign up to the Newsletter so that I can hear about film news and any upcoming events.
- The footer contains a block telling users if they would like to hear about live events they can sign up for the newsletter. By entering their name and email address and clicking 'subsribe' they will automatically receive a thanks for subscribing email and details about the newsletter.
-
- The Website was tested on Google Chrome, Internet Explorer, Microsoft Edge and Safari browsers.
- The website was viewed on a variety of devices such as Desktop, Laptop, iPhone7, iPhone 8 & iPhoneX.
- A large amount of testing was done to ensure that all pages were linking correctly.
- Friends and family members were asked to review the site and documentation to point out any bugs and/or user experience issues.
This project is being resubmitted and all previously identified bugs have been addressed. One new ubg was identified in the most recent round f testing, when a user creates a new review it is added to the latest reviews section on the homepage, but if the user edits this review it no longer appears in this section.
Steps for deploying the website to a hosting platform using Heroku:
- Set up requirements.txt file by typing in the terminal; pip3 freeze –local > requirements.txt to tell Heroku which applications and dependencies are required to run our app.
- Set up a Procfile file by typing: echo web: python app.py > Procfile. Access the Procfile and delete the bottom empty line.
- Open Heroku.com and log in on a dashboard where select “Create a New App”. Create an App name “milestone-3”, choose the closest region Europe and click “Create App”.
- Click “Deploy” and “Deployment method” =GitHub, adding the repository name Milestone-3. Then click “search” and “Connect” to the repository name.
- Select “Settings” and “Config Vars”. Click “Reveal config vars” and fill in the Key and Value pairs from the env.py file.
- Back on Gitpod, in the terminal, add the requirements.txt and Proclife files and run the git commit command, then push to GitHub.
- On Heroku go to "deploy", select “Automatic deploys” and click “Enable Automatic Deploys” followed by “Deploy Branch”.
- it will take a few minutes to update and when it has completed you will see "Your app was successfully deployed." Click "View" to launch the new app. Click on “Open App” which will launch the deployed app.
-
Code Institute Mini Project. Most of the guidance for this site came from the
-
In the App.py= dated added uses "now" string code credit=https://www.programiz.com/python-programming/datetime/strftime
-
The full-screen hero image code came from this w3 schools post
-
Bootstrap4: Bootstrap Library used throughout the project mainly to make site responsive using the Bootstrap Grid System.
-
All content was written by the developer and the users who upload their own content (reviews).
-
Psychological properties of colours text in the README.md was found here
- All Images are uploaded by the user via external links. The banner was created by myself using canva and google searching film stills.
-
My Mentor for continuous helpful feedback.
-
Tutor support at Code Institute for their support.