/budget-blocks-fe

Primary LanguageJavaScriptMIT LicenseMIT

Budget Blocks

Maintainability Test Coverage

You can find the deployed project at Budget Blocks.

Development Team

Adam Skoog Aleksei Zaichenko William Ryan Edward Blanciak
Team Leader Full Stack Developer Full Stack Developer Full Stack Developer


Jess Daniel Nick Nguyen Chris Jakuc Adriann Lefebvere
Full Stack Developer Lead iOS Developer Data Science Specialist Data Science Specialist


Denise Fafette
Project Designer


Administrator Team

Marcus Jones Alex Jones Bernie Durfee Ryan Herr
Section Leader Stakeholder Engineering Manager Data Science Manager


David Monson Elizabeth Lin Lisa Inoue
Design Manager Design Manager Design Manager


MIT React Typescript code style: prettier

more info on using badges here

Project Overview

Trello

Notion

Figma Design Files

General Link

Developer Onboarding

Information Architecture

Task Flows

Typography

Fintech Inspiration

Mission Statement

Our mission is to create a budgeting application that makes budgeting a simple, friendly, and intuitive process for our users. Many budgeting apps face the problem of being over complicated or underwhelming, we want our users to feel like their being helped rather then put to work. Above all us we want our users feel the weight lightened by our application in their pursuit to budget their income rather then be overwhelmed by it.

Key Features

  • Ability to sign up and connect via Okta
  • Ability to connect their bank accounts through Plaid API
  • Custom categories based on the preferences and needs of the users
  • Automated or Manual process of checking and handling their budgeting process
  • Information and suggestions on budgeting based off of users demographic and goals

Tech Stack

Front-End built using:

React, Redux, Okta, Axios, Dotenv

Why did you choose this framework?

  • React is a diverse and varied front-end framework with multiple intuitive dependencies/hooks that make for a not only clean but effective front-end codebase.
  • Redux is a flexible and efficient stage management framework that allows a front-end developer to not only distribute state freely across their application but also gives them the freedom to customize how it may be rendered.
  • Okta is being used to be on par with engineering standards. It's the latest in safe and secure sign up/sign in processing as well as authentication. It is also built in with a number of useful features for the user to recover and update their information as needed.
  • Axios is the dependency we choose for accessing API endpoints on the front-end through GET, POST, PUT, and DELETE requests.
  • Dotenv is what was used to store sensitive information that only our developers should be aware of and have access to for the security of our application.

Styling Library:

Material-UI

Why did you choose this library?

  • We choose Material-UI because it is a naturally intuitive styling library. It contains built-in responsive elements, flexible styling methods, and overall clear and concise documentation for its numerous features.

Front end deployed through Netlify

Content Licenses

Image Filename Source / Creator License
doodles.png Nicole Bennett Creative Commons
rings.svg Sam Herbert MIT

Testing

Tech Used:

Jest

  • Jest is what we choose to use for our front-end testing because React has built in connections for Jest's testing library, Because of this we are to effectively create tests with little to no doubt in its accuracy with the results.

Start-Up Instructions

Step 1 - Clone down front-end repo

Step 2 - npm install from root

Step 3 - npm start for local hosting

Step 4 - Create env.file and fill in the appropriate information

Start-Up env.file format

  • REACT_APP_ISSUER - URL that is used for verification with Okta
  • REACT_APP_CLIENT_ID - ID assigned to each user/team that is needed for verification with Okta
  • REACT_APP_SERVER_HOST - Designated Host for maintaining your Frontend within different environments

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Please note we have a code of conduct. Please follow it in all your interactions with the project.

Issue/Bug Request

If you are having an issue with the existing project code, please submit a bug report under the following guidelines:

  • Check first to see if your issue has already been reported.
  • Check to see if the issue has recently been fixed by attempting to reproduce the issue using the latest master branch in the repository.
  • Create a live example of the problem.
  • Submit a detailed bug report including your environment & browser, steps to reproduce the issue, actual and expected outcomes, where you believe the issue is originating from, and any potential solutions you have considered.

Feature Requests

We would love to hear from you about new features which would improve this app and further the aims of our project. Please provide as much detail and information as possible to show us why you think your new feature should be implemented.

Pull Requests

If you have developed a patch, bug fix, or new feature that would improve this app, please submit a pull request. It is best to communicate your ideas with the developers first before investing a great deal of time into a pull request to ensure that it will mesh smoothly with the project.

Remember that this project is licensed under the MIT license, and by submitting a pull request, you agree that your work will be, too.

Pull Request Guidelines

  • Ensure any install or build dependencies are removed before the end of the layer when doing a build.
  • Update the README.md with details of changes to the interface, including new plist variables, exposed ports, useful file locations and container parameters.
  • Ensure that your code conforms to our existing code conventions and test coverage.
  • Include the relevant issue number, if applicable.
  • You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.

Attribution

These contribution guidelines have been adapted from this good-Contributing.md-template.