Skip to content
Ethan Janicki edited this page Sep 16, 2023 · 4 revisions

Welcome to Our Shell Hacks 2023 Project

Name TBD

Table of Contents

Project Introduction

Welcome to our comprehensive budgeting tool, a perfect blend of simplicity and utility for managing your finances effectively!

Our application is designed to help users gain complete control over their income, providing both macro and micro insights into their spending habits, saving potential, and overall financial health. It takes into account various elements including the user's income and location to craft a personalized and accurate budget plan.

Our application offers features such as:

  • Detailed budget summaries: Provides you both pointwise and verbose summary of your spending, earnings, savings and more.
  • Stock data visualization: Renders your financial data into easily understandable graphs, saving you from the hassle of complicated number crunching.
  • Stock performance feedback: Not only shows you the raw data of your stocks but also summarizes the performance, providing actionable feedback and insights that can drive your investment decisions.
  • Investment outcome previews: The application shows you potential outcomes of your investments, painting a picture of what you could do with your possible profits.

Our goal is to empower users with the tools, insights, and confidence to manage their finances effectively. Whether you're an experienced investor or just starting out, our application promises to be a reliable companion on your financial journey.

Setup Instructions

Follow these steps to get our project up and running on your local environment:

Please note that each will be running on a separate port so these should be done in different terminals.

Running the database

Navigate to the directory

../shellhacks2023/pocketbase_0.18.6

run the command

./pocketbase serve

The app should run on localhost:8090

Running the backend server

Navigate to the directory

../shellhacks2023/backend

run the command

npm i
npm start

The app should run on localhost:5000

Usage

This section deals with steps on how to use your application. You can use code snippets to make it clear.