yashitz07/Spendwise

Spendwise - Your User-Friendly Expense Tracker

Spendwise

Your User-Friendly Expense Tracker Empowering Your Finances.
Kharagpur Winter of Code . Report Bug . Request Feature

Community

We would love to hear from you! We communicate on Slack:

Table Of Contents

• About the Project
• Built With
• Getting Started
  • Prerequisites
  • Installation
• Ideas List
• Authors
• Code Contributors

About The Project

Spendwise: Your intuitive, user-friendly expense tracker. Seamlessly manage and understand your finances with simplicity and precision. Track, analyze, and take control of your expenses effortlessly.

(back to top)

Built With

Spendwise is powered by a modern tech stack:

• : Dynamic user interfaces.

• : Efficient server-side scripting.

• : Streamlined API development.

• : User profile and authentication.

• : Real-time handling of the transactions of the users.

This combination ensures a seamless and powerful expense tracking experience.

(back to top)

Getting Started

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• npm

npm install npm@latest -g

Installation

1. Fork the repository

2. Clone Your Forked Repository:

git clone https://github.com/<your_username>/Spendwise.git

Client (Frontend)

3. Navigate to the Client Directory:

cd Spendwise/client

4. Install Dependencies:

npm install

5. Start the Application:

npm run dev

The client will be running on http://localhost:4000 in your browser.

Server (Backend)

1. Navigate to the Server Directory:

cd Spendwise/server

2. Install Dependencies:

npm install

3. Start the server

npm run dev

The server will be running on http://localhost:3000

(back to top)

Ideas List

1. Development Simplification:

   • Make the project easily deployable through Docker for streamlined development.
   • Enable compatibility with Codespaces and Gitpod to facilitate collaborative coding.

2. User-Friendly Interface:

   • Improve the current user interface for simplicity and clarity.
   • Implement basic user feedback mechanisms.

3. Enhance Expense Categorisation:

   • Extend the categorisation system with subcategories or tags.
   • Explore ways to improve the visibility and usability of categories.

4. Implement Filters and Search:

   • Add basic filtering options for expenses based on categories, dates, or amounts.
   • Implement a search feature to easily locate specific transactions.

5. Codebase Refinement and Documentation:

   • Implement consistent coding standards and practices for improved readability and maintainability.
   • Create thorough documentation covering project architecture, API endpoints, and key code modules.

(back to top)

## Authors

• Ankit Kumar Chowdhury - Organisation Admin
• Niladri Sekhar Adhikary - Organisation Admin

Code Contributors

(back to top)