Skip to content

zahrabayatt/expense-tracker

Repository files navigation

Expense Tracker

This repository contains an Expense Tracker application developed by zahrabayatt. The Expense Tracker is a web-based application that helps users track and manage their expenses effectively.

Features

  • Expense Tracking: Users can easily record their expenses, including the description, category and amount spent.
  • Categories: The application provides pre-defined categories to categorize expenses, making it easier to analyze spending patterns.
  • Expense List: The application generates a detailed table displaying the expense records. Users can delete individual records and view the total amount of expenses.

Technologies Used

The Expense Tracker application utilizes a variety of technologies and frameworks, including:

  • TypeScript: A statically-typed superset of JavaScript that enhances code quality and scalability.
  • React.js: A powerful JavaScript library for creating user interfaces and building reusable UI components.
  • Next.js: A React framework that provides server-side rendering, static site generation, and other performance optimizations.
  • Bootstrap: A popular CSS framework that offers pre-designed components and responsive layouts for fast and easy web development.
  • Zod: A TypeScript-first schema validation library that ensures data consistency and type safety.
  • React Hook Form: A lightweight library for managing form state and validation in React applications.
  • HookForm/Resolver: A library extension for React Hook Form that allows for declarative form validation and error handling.

Setup Instructions

To run the Expense Tracker application locally, follow these steps:

  1. Clone the repository: git clone https://github.com/zahrabayatt/expense-tracker.git
  2. Navigate to the project directory: cd expense-tracker/src
  3. Install dependencies: npm install
  4. Start the development server: npm run dev
  5. Access the application in your web browser at http://localhost:3000

Contribution Guidelines

Contributions to this repository are welcome. If you want to contribute, please follow these guidelines:

  1. Fork the repository.
  2. Create a new branch for your feature/bug fix: git checkout -b my-feature
  3. Commit your changes: git commit -am 'Add new feature'
  4. Push to the branch: git push origin my-feature
  5. Submit a pull request detailing your changes.

License

The Expense Tracker application is open source and released under the MIT License.

Feel free to use, modify, and distribute the code for personal and commercial purposes.

Acknowledgements

This application was developed as a personal project by zahrabayatt.

If you have any questions or suggestions regarding the Expense Tracker, please feel free to open an issue in the repository.