Skip to content

phloreenm/jan-hackathon

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

This project was submited in the Code Institute Hackathon contest of January 2023 and it won 1st place.

January 2023 Hackathon: 1st Place

Awarded: 24 Jan 2023

Awarded To: Florin Maracine

The Bucket Calculator App is based on Dan Lok’s 5 Bucket Money Management Concept.

His concept was designed to teach the user the habit of managing money as a long term solution. This is done by breaking the salary into 5 different buckets; Expenses, Emergency, Investment, Learning and Fun. The suggestion is to commit 60% of our salary to the Expenses bucket and 10% in each of the others. However, these percentages can be adjusted to suit bigger and smaller salaries.

Mockup Image Deployed App

Whilst sharing ideas and starting to brainstorm, we tried to take into consideration the skills and strengths of each team member and work on a project where everyone can get involved. We decided to build a front-end app which meant the majority of the team could contribute.

Using Dan Lok’s concept we built a calculator where the user could find out how much money would go in each bucket based on their salary.

We decided to the it a bit further and create a "Buckets Breakdown" calculator where the user can have a better tracking of their expenses. Once the user fills the form a chart will appear and the user can compare how their salary is distributed in the 5 buckets compared to Dan Lok's concept.


Table of contents


UX


User Stories

Primary Goals:

  • To be able to use the site on different screen sizes (responsiveness).
  • To see an easy to read breakdown of my spending (chart.JS)
  • To use an accessible site that accounts for all users (colour-blindness, screen readers).

Secondary Goals:

  • I want to be able to customize the label names on the charts.
  • I want to see a comparison of my spending / saving compared to the recommendations (5 Bucket Principle).

Tertiary Goals:

  • I want to be able to save the charts to view later (download as PDF).
  • I want to be able to use this site in a range of countries (currency converter API)
  • I want to be able to access guides on saving and spending less.

Wireframes

Desktop

Main Page

Main page mock up design

Calculator

Calculator page mock up design

Tips Page

Tips page mock up design

About Page

About page mock up design

Mobile

Main Page

Main page mock up design

Calculator

Calculator page mock up design

Tips Page

Tips page mock up design

About Page

About page mock up design

Back to top


Style and colours

Color Palette

The colour palette for this project is based on the purple colour scheme. The purple colour is considered to be a colour of creativity and imagination and complements beautifully the project idea.
Background colour #f2f2fc Ghost White
Hero background color #ffffff White Text colour #332a7c Picotee Blue
Footer background #d3d3f1 and #a9a9d7 Light Periwinkle and Blue Bell
Color Palette Image

Typography

The fonts used are Open Sans and Playfair Display which really complement eachother and give the project professional look.

Imagery

Creative Fabrica The images used are from Creative Fabrica and come with license for commercial use.

Back to top


Features

Existing Features

  • Header - The header consist of the name of the project on the left and the navigation links on the right. On mobile devices the navigation turns into hamburger menu and the links to the pages appear sliding from the left. This is to guarantee better user experience on smaller devices.

  • Hero sections - There is a hero section on the home page, the tips page and the about page. It consist of relevant to the page heading and image. The hero section on the home page has a see more button which will take the user to the about page which will provide the user with more information.

Feature2

Back to top


Home Page

  • The home page consist of image which visually represents the main idea behind this project. Presenting the information in a more visual way helps the user the understand the concept easier. This is then followed by section which goes into a bit more detail about the concept followed by a button which when clicked will take the user to the calculator page.

Image of Home Page

Back to top


Calculator Page

  • The calculator page has 3 sections:
    1. The 5 Bucket Calculator Users can enter their salary and click calculate to find out how much money has to go in each bucket based on Dan Lok's theory
    2. The Buckets Breakdown Users can enter all their regular payments to track how their money is spend. Once they click calculate they will be presented with a chart of their own buckets compared to Lok's theory.
    3. The Currency Convertor

Back to top


Tips Page

  • The Tips page consist of carefully selected and presented information for the user for better money management. On the left there is a collapsible list with 5 tips followed by image representing saving. On the right there is more information about credit card usage.

Image of Calculator Page

Back to top


About Page

  • The About page was created to provide more information to the user about the Five Bucket Method. It also has a button which takes the user to the calculator page.

Image of Calculator Page

Back to top


Team Page

  • The Team page consist of information about the team who created the project and links to each member's LinkedIn and GitHub.

Back to top


Future Features

  • Download Data

    • Users have the option to export and download a pdf file of their data after using the calculator.
  • User Login

    • Users have the option to create an account where they can easily save and adjust their details.
  • Convert Currency

    • Once the user has used the calculator their will have they option to automatically convert all figures to a different currency. As we did not have the time to add this functionality on the finished app, we decided to add a separate currency convertor bellow the calculators.
  • Link your Banking App

    • Users have the option to link their banking app and every time they make a transaction it is automatically added to their Buckets Breakdown. This makes it easier for users to keep a track of all speedings without having to manually enter it.

Back to top


Technologies Used

  • GitHub - GithHub is the hosting site used to store the source code for the Website and Git Pages is used for the deployment of the live site.
  • Git was used as version control software to commit and push code to the GitHub repository where the source code is stored.
  • Google Chrome Developer Tools was used as a testing tool during the development of the application.
  • Google Fonts was used to import the fonts Open Sans and Playfair Display
  • Font Awesome was used for icons.
  • Balsamiq Wireframes was used to create the wireframes for the mobile version of the application.
  • Photoshop was used to create the desktop mockups and resize and export the images for web.
  • Coolors.co was used to display the colour palette
  • Favicon.io was used to create the favicon for the website.
  • Exchangerates APIwas used for the currency converter

Languages

  • HTML - used to build the main structure of the website.
  • CSS - custom written CSS was used as an addition to Materialize.
  • Materialize Framework - used throughout the website for layout and styling.
  • JavaScript - was used to create functionality for the calculator.
  • Jquery

Back to top


Testing

All testing can be found here


Deployment

GitHub Pages

The website is deployed using GitHub pages. It automatically updates new commits as they are pushed to the repository.

How to deploy GitHub Pages

  1. Login to my GitHub account
  2. Open the repository
  3. Click on Settings
  4. Scroll down and click on the Pages tab located on the left of the screen
  5. Under 'Source' select the main branch
  6. Wait for the page to refresh
  7. Scroll down to and locate the website link under the 'GitHub Pages' section

Cloning the repository

  1. Open the repository
  2. Click the Code button above the list of files
  3. Click on GitHub CLI and click on the 'copy' button to copy the URL link
  4. Open GitPod
  5. Type 'git clone' and paste the URL link

Find more here

Back to top


Credits

Acknowledgements

  • The Hackathon Team - Big thank you for making this Hackathon happen. It was great experience.

Back to top


*Disclaimer: This Project was created for January's Hackathon. It should not be taken as actual financial advice.

Releases

No releases published

Packages

No packages published

Languages

  • HTML 81.1%
  • JavaScript 12.9%
  • Dockerfile 3.8%
  • CSS 2.2%