Giter VIP home page Giter VIP logo

burgerjoint's Introduction

Burger Joint

The Burger Joint corporate website allows clients of the Burger Joint restaurant to book table reservations and order food delivery in advance as well as as edit, delete or update their scheduled dine-in bookings or food deliveries should their plans change. A prerequisite to making a table booking or food delivery from the Burger Joint restaurant, the client must create or have a registered user account with the Burger Joint restaurant, otherwise, they will not be able to complete a table booking or order a food delivery from the restaurant.

Link to live site here.

image of the Burger Joint website home page on all devices

Business Requirements

Prior to initiating the project's development, user stories were created to give a high level understanding of what the platform's functional requirements will be and they were assigned labels based on their importance using the MoSCoW prioritization method.

image of the burger joint userstories

The user stories were then placed into a kanban board in order to track the progress of the platform's development. The Agile development kanban board can be found here.

image of the burger joint project agile kanban board

Wireframes

Once the user stories were completed, the next phase of the project was to complete the UX of all the expected pages and different CRUD functionalites in the platform. The wireframes were done with a focus on mobile and web; tablets were expected to be an enlarged version of the mobile experience.

Burger joint project wireframes

Database Schema

After the wire-frames completion, a database schema was created to understand what information should be stored on the back-end database.

Project DB schema

Features

The Burger website consists of the following pages and features:

  • Landing Page

landing page

  • Menu with filtration options - web

menu

  • Menu with filtration options - mobile

mobile menu

  • Create Table Booking Page

table booking page

  • View Bookings Page with options to edit or delete bookings

view bookings page

  • Edit or Update Booking Page

Edit bookings page

  • Create Food delivery order page

create food delivery page

  • View Food Deliveries Page with options to edit or delete delivery

view deliveries page

  • Edit or Update food delivery Page

Edit delivery page

  • Pop-up to confirm deletion of table booking or food delivery

pop-up to delete booking or delivery

  • Account Registration Page via username or google account

account registration page

  • Account Log-in Page via username or google account

account login page

  • Account Log-out confirmation Page

account logout page

Testing

All fucntional testing, user story testing, device compatibility testing and browswer compatibility testing can be found in the TestingMD file.

Deployment

Deployment of the Burger Joint application was done from the very start of the project and continous deployment was performed after every feature implementation in order to avoid any unforeseen hurdles or blockers during the final deployment of the application. Upon implementing the django framework and PostgreSQL databse in the my local environment, in order to deploy the project, the following steps were taken:

  • I created a new application in Heroku by giving it an app name and selecting its region.

  • Then in Elephant SQL I created a new instance in order to host the database.

  • I copied the Elephant SQL Postgres URL which I then pasted into my env.py file and then added a few lines of code in my settings.py file to make my django project aware of it.

  • I completed migration of the database structure to the newly connected ElephantSQL database.

  • Once the database had been migrated to ElephantSQL and a Procfile for Heroku was created, in the application's Heroku interface I added a few config vars in the project's settings.

  • Finally in the app's Heroku interface in the deploy section, I connected the project's Github repository and initiated manual deployment.

Credits

burgerjoint's People

Contributors

xalil404 avatar

Watchers

 avatar

burgerjoint's Issues

USER STORY: Landing Page

As a user, I want to view the landing page of a restaurant which contains its menu offerings.

USER STORY: Create Booking

As a user, I want to be able to book a table at the restaurant which includes my details such as: name, phone number, email, number of guests, date and desired meals.

USER STORY: Log Out

As a user, I need to be able to log out of my account if I happen to be on a device that isn't mine and I would like to protect my account.

USER STORY: Sign In

As a user, I want to log-into my account with the restaurant in order to CRUD bookings.

USER STORY: Admin Interface

As an administrator and owner of the restaurant, I need to access an interface where I can see the list of total bookings and the bookings' details.

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.