Skip to content

Ayaan2907/PennyBuddy

Repository files navigation

PennyBuddy

PennyBuddy is a finance management web application built with Next.js 13 using the app directory structure. It allows users to manage their finances with ease, featuring account creation, login, and more.

Features

  • User Registration and Authentication
  • Finance management tools (to be expanded)
  • Responsive design using Tailwind CSS

Technologies Used

Getting Started

Follow the instructions below to set up and run the project locally.

Prerequisites

Make sure you have the following installed on your local machine:

  • Node.js (v14.17.0 or higher)
  • npm (v6 or higher) or yarn

Installation

  1. Clone the repository:

    git clone 'url'
  2. Navigate to the project directory:

    cd pennybuddy
  3. Install dependencies: You can either use npm or yarn to install the required dependencies:

    # Using npm
    npm install
    
    # OR using yarn
    yarn install

Running the Project

  1. Start the development server: After installing the dependencies, run the following command to start the Next.js development server:

    # Using npm
    npm run dev
    
    # OR using yarn
    yarn dev
  2. Open the application: Once the server is running, open your browser and navigate to:

    http://localhost:3000