Skip to content

Wall Covering Calculator and Material Procurement Portal

License

Notifications You must be signed in to change notification settings

mbussert/shaw-ppc

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Wall-Pro MPP

--Wall Covering Calculator and Material Procurement Portal--

shaw-ppc

Table of Contents:

About This Project:

Links:

Deployed Application: http://www.WallPro.net
Repository: https://github.com/mbussert/shaw-ppc

Description:

The application will assist clients in calculating square footage measurements for wall installation material deliverables on behalf of the design company. The average user will be able to utilize the calculator tool to place product orders, save their account info to view order history, and notify the administration team of their new orders.

User Story:

  • GIVEN I need to submit vinyl installation projects with specific measurements to a designer
  • WHEN I visit the home page
  • THEN I am able to create an account or proceed to the calculator tool and information about how the calculator tool works
  • WHEN I visit the “How it Works” page
  • THEN I am able to view a video detailing how I should use the calculator tool, along with step-by-step instructions that are simple to follow
  • WHEN I view the “Calculator Tool” page
  • THEN I am able to view previous projects I have submitted (if I am logged in), and create a new project
  • WHEN I choose to create a new project
  • THEN a modal appears (if I am not logged in) reminding me to log in if I want my project to be saved, and have the option to continue if I do not want to create an account
  • WHEN I continue to create a new project
  • THEN I am asked to create a name/number for the first wall of the vinyl installation project
  • WHEN I submit my new name/number for the first wall
  • THEN I am asked to choose which material I would like for the wall
  • WHEN I submit my chosen material and choose to continue
  • THEN I am asked to choose a unit of measurement from a dropdown list that will be used for calculations
  • WHEN I enter a unit of measurement and choose to continue
  • THEN I am asked to enter the total length of the wall
  • WHEN I have entered the total length of the wall and continue
  • THEN I am prompted to choose whether to include an additional six inches of vinyl material to my measurements for production purposes
  • WHEN I click the “Calculate” button
  • THEN I am shown my project’s details and calculated measurements
  • WHEN I save the new project
  • THEN the project is added to my existing projects in the sidebar
  • WHEN I click an existing project in the sidebar
  • THEN I am able to add and save additional walls to the project
  • WHEN I view my “Account” page
  • THEN I am able to easily view details about all projects I have submitted
  • WHEN I am offline
  • THEN basic functionality of the site persists

Built With

Frameworks Dependencies
React Sass
MySQL Material-UI
JavaScript NodeMailer
HTML React Player
CSS Express
Node.js Axios
Sequelize Passport

Team:

Getting Started

Installation:

  1. Clone the repo
    git clone https://github.com/mbussert/shaw-ppc.git
  2. Install NPM packages
    npm install
  3. Start the application on localhost:3000
    npm start

Usage:

Gif demo of WallPro

License:

This application is covered under GNU AGPL v3.

Contributing:

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

Tests:

Tests for this web application have been built with Jest and Enzyme. To run the tests, cd into the client folder and ensure that all dev dependencies have been installed correctly. Then, run npm test run all testing suites.

About

Wall Covering Calculator and Material Procurement Portal

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published