Giter Club home page Giter Club logo

johannes2503-project-1-restaurant_mayresub's Introduction

Restaurant

Restaurant is a restaurant located in a small fishing village in Grindavik Iceland. It was founded by the owner Láki in 2009. Their speciality is fish courses. Cod in particular. They strive to deliver excellent service and quality food.

Welcome to the journey through Restaurant

Restaurants responsive design

Contents

User Experience (UX)

Wireframes

The wireframes for Restaurant were produced in Figma. There are frames for a full width display. The final site varies slightly from the wireframes due to developments that occured during the creation process.

Desktop wireframe image

Back to top

Site Structure

Restaurant website has four pages. The home page is the default loading page, Menu page, Reservations and contact pages are all accessible primarily from the navigation menu.

Back to top

Design Choices

  • Typography

    The fonts chosen were 'Parisienne' for the main heading and 'Poppins' for the headings and text. They fall back to cursive and sans-serif respectively.

    • ''Parisienne' was chosen for the headings to give the user an inital welcoming feel. The cursive style generally feels more inviting and less intimidating for the user than others.
    • 'Poppins' is used for the body text as it provides a nice contrast to the cursive whilst being easy to read for all.
  • Colour Scheme

    The colour scheme eventually chosen is one based on green and off-white. The colour contrasts with the wood colour in many of the images. Green traditionally gives the impression of energy, safety and growth.

Colour Palate image

Back to top

Features

Restaurants site is set up to be welcoming and easy to use. It contains many features that the user would probably be familiar with, such as a navigation bar and contact form. The overall feel of the website is intended to be inviting and not intimidating to encourage the user to explore further.

Existing Features

  • Navigation Menu

    • Sited at the top of all the pages in the site, it is fully responsive and contains links to all the pages of the site to enable ease of navigation in one convenient location.
    • The logo is clickable with a link back to the home page for enhanced UX.

Navigation bar image

Back to top

  • Owners Welcome

    • Located on the home page beneath the title section. It is supposed to invite the user to have a enjoyable evening in the good hands of the owner.

Owners welcome image

Back to top

  • Reviews

    • The reviews section adds to the trust that Restaurant is a place of excellent service and food.

Reviews image

Back to top

  • Footer

    • Contains social media links. To enhance the UX the links open in other tabs.
    • The social media presence will help the user with their research into Restaurant.
    • The footer also contains information about opening hours and contact info.

Footer image

Back to top

  • Menu page

    • The menu page contains every course that the restaurant offers.
    • The menu items alternate to be more interesting to the user.

Menu page image

Back to top

  • Reservations page

    • On the reservations page users can order a table at the restaurant.
    • The form askes for information from the user. First name, last name and so on and sends it then on to the restaurant when the user clicks send.
    • The user can pick a date and time from a calendar picker.

Reservations page image

Back to top

  • Contact us page

    • On the contact page users can contact the restaurant.
    • The form askes for information from the user. First name, last name and so on and sends it then on to the restaurant when the user clicks send.

Contact page image

Back to top

Future Features

  • A 'Order' section so the user can order takeaway food.
    • This would incorporate an e-commerce platform and an enhanced menu page.
  • Introduce swipe actions for use on mobile devices for the menu items sliders.

Back to top

Technologies Used

  • HTML5 - provides the content and structure for the website.
  • CSS - provides the styling.
  • Figma - used to create the wireframes.
  • Gitpod - used to deploy the website.
  • Github - used to host and edit the website.

Back to top

Testing

Code Validation

The Restaurant site has be throughly tested. All the code has been run through the W3C html Validator and the W3C CSS Validator. Errors were found on the home and menu pages. After a fix and retest, no errors were returned for both.

The HTML validator results for each page are below:

  • Home page

W3C Validator test result

  • Menu page

W3C Validator test result

  • Reservations page

W3C Validator test result

  • Contact page

W3C Validator test result

The CSS validator results are below:

CSS Validator test result

Responsiveness Test

Moto G4 Galaxy S5 iPhone 5 iPad iPad Pro Display <1200px Display >1200px
Render pass pass pass pass pass pass pass
Images pass pass pass pass pass pass pass
Links pass pass pass pass pass pass pass

Note: On wide display types the contents of the site are restricted in width to 2000px. This helps the UX by not spreading the content too wide on the extra wide screens.

Browser Compatibility

Restaurant site was tested on the following browsers with no visible issues for the user. Google Chrome, Microsoft Edge, Safari and Mozilla Firefox. Appearance, functionality and responsiveness were consistent throughout for a range of device sizes and browsers.

Known Bugs

  • Resolved

    • During validation two bugs became known during the validation stage, a brief description is below:

    • Home page - There was an error in the section for the hero-image. Had to change the section to a div to fix it.

    • Menu page - Had numerous bugs on the menu page. Had been using colspan="number" when I didn't have to. Took me quite a while to figure that one out. Fixed it by getting rid of it and then it was good to go.

  • Unresolved

    • The form, on the face of it acts like you would expect it to, it acknowledges your data input, however the data doesn't push anywhere. This is a limitation within this project and would be rectified for a true deployment of the Restaurant site.

Back to top

Deployment

To deploy the project

The site was deployed to GitHub pages. The steps to deploy a site are as follows:

  1. In the GitHub repository, navigate to the Settings tab.
  2. Once in Settings, navigate to the Pages tab on the left hand side.
  3. Under Source, select the branch to main, then click save.
  4. Once the master branch has been selected, the page will be automatically refreshed with a detailed ribbon display to indicate the successful deployment.

GitHub pages deployed image

The live link to the Github repository can be found here - https://github.com/johannes2503/Project-1-Restaurant

To fork the repository on GitHub

A copy of the GitHub Repository can be made by forking the GitHub account. This copy can be viewed and changes can be made to the copy without affecting the original repository. Take the following steps to fork the repository;

  1. Log in to GitHub and locate the repository.
  2. On the right hand side of the page inline with the repository name is a button called 'Fork', click on the button to create a copy of the original repository in your GitHub Account. GitHub forking process image

To create a local clone of this project

The method from cloning a project from GitHub is below:

  1. Under the repository’s name, click on the code tab.
  2. In the Clone with HTTPS section, click on the clipboard icon to copy the given URL. Cloning image
  3. In your IDE of choice, open Git Bash.
  4. Change the current working directory to the location where you want the cloned directory to be made.
  5. Type git clone, and then paste the URL copied from GitHub.
  6. Press enter and the local clone will be created.

Back to top

Credits

Content

Media

  • The most photos came from the developer.
  • The photos that were not from the developer came from Unsplash.

Back to top

Acknowledgements

The site was completed as a Portfolio 1 Project piece for the Full Stack Software Developer (e-Commerce) Diploma at the Code Institute. As such I would like to thank my mentor Precious Ijege, the Slack community, and all at the Code Institute for their help and support. Also want to thank Ewan Colquhoun for the README.md template which this readme is based on.Ewan Colquhoun. Restaurant is a fictional restaurant based on my father in laws place. Which is located in my home town.

Johannes Hreinsson 2022.

Back to top

johannes2503-project-1-restaurant_mayresub's People

Contributors

johannes2503 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.