Skip to content

JacobArthurs/expense-tracker-frontend

Repository files navigation

Expense Tracker Frontend

This project is an Expense Tracker frontend made using React, Material UI, and Vite. It is designed to work in conjunction with my Expense Tracker API, ensuring a full-stack application experience.

Prerequisites

Before you begin, ensure you have met the following requirements:

  • Node.js installed.
  • Git installed.

Getting Started

To get the Expense Tracker Frontend up and running, follow these steps:

  1. Clone the repository:

    git clone https://github.com/JacobArthurs/expense-tracker-frontend.git
    
    cd ./expense-tracker-frontend/
  2. Install dependencies:

    npm install
  3. Create a '.env' file at the root of the directory containing the following:

    VITE_API_URL=http://localhost:8080
    

    This URL should be adjusted according to where the Expense Tracker API is running.

  4. Start the development server:

    npm run dev

Usage

  • Navigating the Frontend

    Access the frontend by navigating to http://localhost:5173/ in your web browser. This URL hosts the local development server version of the Expense Tracker Frontend.

  • Account Registration

    For new users, click on "Register" located in the top right corner of the homepage to create a new account. Follow the prompts to enter your details and set up your account.

  • Exploring Features

    Once registered, you can log in to access and utilize the full functionalities of the Expense Tracker website, including adding, viewing, and managing expenses, categories, and distributiuons.

Collaboration and Feedback

If you spot any areas for improvement or have suggestions, please don't hesitate to reach out. Whether it's through contacting me directly, opening an issue, or submitting a pull request, I welcome your input. Constructive criticism is invaluable for growth and improvement, and I appreciate your contributions to making this project better.