Git Product home page Git Product logo

resolve's Introduction

Resolve


Overview

Resolve is an app that helps users track personal goals. Users can create a profile where they can add new goals, list their motivation for achieving said goal, and outline a plan for success. Users can view the goals of others who have created a Resolve profile. In addition to adding new goals, they can also delete and edit the goals associated with their own profile.

Team Members

Created, designed, and developed by Abir Tawfique (Git Czar), Revati Rajabhathor, and Hannah Reilly. for the General Assembly Software Engineering Immersive (November '19 Cohort) Unit 3 Project.

Team Expectations

Team values and expectations can be found on our project's Google document.

Permissions

Digital assets stored locally and on Imgur.


MVP

Resolve is an app that helps users track personal goals. Users can create a profile where they can add new goals, list their motivation for achieving said goal, and outline a plan for success. Users can view the goals of others who have created a Resolve profile. In addition to adding new goals, they can also delete and edit the goals associated with their own profile.


MVP Goals

  • Allow users to log-in/log-out.
  • Allow users to register for the website and create a new profile.
  • Allow users to add, delete, and edit the goals on their own profile. -Allow users to mark goals as complete. -Have completed goals change color.
  • Once logged in, allow users to click on other user profiles and view their goals (without power to add, edit, or delete).

MVP Libraries

Use this section to list all supporting libraries and dependencies, and their role in the project.

Library Description
React The front-end will be programmed using React.
React Router Dom React Router will be used to route users between profiles.
Express The back-end will be programmed using Express.
Express Router Express Router will be used to create API routes to hit with the frontend.

MVP Client (Front End)

Wireframes

Use the Wireframes section to display desktop, tablet and mobile views.

Desktop Landing

  • Desktop Landing

Desktop Login/Register

  • Desktop Login/Register

Resource Index

  • Resource Index

Resource Profile

  • Resource Profile

Component Hierarchy

Use this section to define your React components and the data architecture of your app.


src
|__ components/
      |__ Header.js
      |__ LandingPage.js
      |__ Login.js
      |__ Register.js
      |__ Goal.js
      |__ CreateGoal.js
      |__ UpdateGoal.js
      |__ Profile.js
|__ services/
      |__ apiHelper.js

Component Breakdown

Use this section to go into further depth regarding your components, including breaking down the components as stateless or stateful, and considering the passing of data between those components.

Component Type state props Description
Header functional n y Reusable component. Depending on if the user is logged in or not, the header will contain the logo, login/register buttons or logo and profile picture + logout.
Landing Page functional n n The landing page is a static body element that is plugged into App.JS to create a landing page..
Login class y y Login form. We’ll save the username and password to state that way we can send it to the api call.
Register class y y Register form. Very similar to login form.
CreateGoal class y y Form that allows user to add a new goal.
CreateGoal class y y Form that allows user to update a goal.
Goal class y y Reusable component. Will render the goal information through api calls. And depending on if user is logged in, we will show completed, edit, delete buttons.
Profile functional n y Reusable component. Will render profile for each user and will render their goals.

Component Estimates

Use this section to estimate the time necessary to build out each of the components you've described above.

Task Priority Estimated Time Time Invested Actual Time
Header M 1 hrs TBD TBD
Landing Page M 3 hrs TBD TBD
Login H 3 hrs TBD TBD
Register H 3 hrs TBD TBD
CreateGoal M 3 hrs TBD TBD
UpdateGoal M 5 hrs TBD TBD
Goal M 4 hrs TBD TBD
Profile M 5 hrs TBD TBD
TOTAL 28 hrs TBD TBD TBD

MVP Server (Back End)

ERD Model

ERD Model

  • ERD Model

Data Hierarchy

Use this section to display the database, table, and attribute hierarchy.


database_db
|__ users/
|__ goals/



Post-MVP

-Register Page: Add typewriter css to say “Get...cooking/running/healthy/git/etc/”

  • Landing Page: Allow users to associate themselves with “groups” so they can first see the user profiles from their own group at the top of the page and the user profiles of other groups at bottom of page. -Landing Page: Make user profiles appear as a pop-up on click, as opposed to redirecting to a new page. -Landing Page: Add search-bar functionality to search other users.
  • User Profile: Add “member since” date to user profile.
  • _Goals Page: when an in-progress goal is completed, push goal to “Done” section.
  • Goals Page: Incorporate “created date” of goal in each goal card.


Project Delivery

The Delivery section should be expanded and revised as you work on your project.


Code Showcase

Use this section to include a brief code snippet of functionality that you are proud of and a brief description.


Code Issues & Resolutions

Use this section to list of all major issues encountered and their resolution, if you'd like.


  • Hannah's Drawing Hannah's Drawing

  • Revati's Drawing Revati's Drawing

  • Abir's Drawing Abir's Drawing

resolve's People

Contributors

atawfique21 avatar revatir avatar hannahreilly avatar crharding avatar

Watchers

James Cloos 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.