Skip to content

EdenKhaos/Lets-Get-Married

Repository files navigation

Lets-Get-Married

lets get married logo


Table of Contents


Project Description

A simple wedding planner app focusing on small or intimate weddings due to COVID-19, that is forcing many couples to scale down their big day! .This application will keep couples be organized, on tasks and provide resources for small weddings on a budget.


Reference Links

Link to Let's Get Married Application deployed on Heroku - Let's Get Married Application Live Link

Link to GitHub Repo used for application development - Let's get Married Application GitHub Repo


User Story

Users can search for venues, lodging and cater options for their wedding.This will call an API that
will return an array of results.
Users can make an account to keep track of tasks, budget and guest lists, SO THAT they can be
organized. 

Concept

This application is a full stack app that will allow an user to plan and manage their own wedding. The purpose of creating this application is to give a starting point to narrow down the important aspects of a small wedding and sticking to a strict list and budget. This should allow couples to plan their 'Big Day' with minimizing the need to cancel their plans due to COVID restrictions.

Actions Diagram

Design

The overall design in this section will address how the application generally functions in it's entirety.

Architecture

This application was created with MVC (model-view-control) as the basis of design. This type of organization allows the application to have a front-end user interaction separate from the back-end logistic functionality. Below diagrams shows the building blocks of this application's creation.

MVC

Click to expand!

MVC

Wireframes

Click to expand!

Wireframes


Application MVP

  • The user can register and login.
  • The user can see his/her profile.
  • The user can list, create, and edit the API lists once registered.
  • The user can search venues, search catering, search lodging using the Google Places/Maps.
  • The user can logout .

Installation Instructions

In order to successfully develop and launch this assignment, the following items must be installed and/or accessible from your working environment (i.e. laptop, computer, etc.).

  • Node.js - Make sure Node.js is installed in your machine. If Node.js is not installed on your machine, click here to download the application.
  • Node Modules - This project used various node modules, which are listed in the package.json files listed in both the client folder and main root folder of this application. A screenshot of dependencies listed in each package.json file are listed included below. Please run npm install or in your terminal to install all required node modules.

Once all dependencies are installed run npm run start to start the application locally.

Package.json file in Root Directory

Click to expand!

Package.json file in Root Directory

Package.json in Client Folder

Click to expand!

Package.json in Client Folder


File Structure and Technologies Used

  • Model-View-Controller (MVC) framework as an architectural pattern

    Click to expand!

    MVC folder pattern for this project

  • Node.js

  • React.js

  • Google Maps API

  • Google Places API

  • Google Geolocation API

  • React-Bootstrap

  • User Authentication using app.js and UserContext.js


Core Node Dependencies

The dependencies listed below are all the NPM packages used throughout this project.

  • axios
  • MySQL
  • Sequalize
  • express
  • passport
  • react-router-dom
  • date-fn
  • @reach/combobox
  • @react-google-maps/api
  • use-places-autocomplete

Future Development

For future development, we would like to incorporate the following feature enhancements into our web application:

  • Add checklist page and saved data to pass through DB.
  • Make guest list and budget pages to save data to pass through DB.
  • Modify current elements to allow deletions for map pins, budget items, guest list, and checklist items.

Team Members


Photo Credits

Table of Contents

About

A wedding planner app focusing on small or intimate weddings due to COVID.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •