CoinGuard

Take control of your personal finances with comprehensive tracking and insights
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

CoinGuard is a comprehensive web application designed to help you take control of your personal finances. Whether you're looking to track your daily expenses, monitor your income streams, or set ambitious financial goals, CoinGuard provides you with the tools you need to make informed financial decisions.

Key features include:

• Income & Expense Tracking - Monitor all your financial transactions in one place
• Savings Management - Track your savings progress and set realistic targets
• Financial Goal Setting - Define and work towards your financial objectives
• Comprehensive Reports - Generate detailed insights about your financial health
• User-friendly Interface - Clean, intuitive design built with modern web technologies

CoinGuard empowers you to understand your spending patterns, identify areas for improvement, and build a stronger financial future. No more wondering where your money went – with CoinGuard, you're always in control.

(back to top)

Built With

CoinGuard is built using modern web technologies to ensure a fast, reliable, and user-friendly experience.

• 
• 
• 
• 

(back to top)

Getting Started

To get a local copy of CoinGuard up and running, follow these simple steps.

Prerequisites

Make sure you have the following installed on your system:

• Node.js (version 18 or higher)
• npm

  npm install npm@latest -g

Installation

1. Clone the repository

   git clone https://github.com/StereoPT/coin-guard.git

2. Navigate to the project directory

   cd coin-guard

3. Install NPM packages

   npm install

4. Set up your database with Prisma

   npx prisma migrate dev
   npx prisma generate

5. Start the development server

   npm run dev

6. Open http://localhost:3000 in your browser to see the application

(back to top)

Usage

CoinGuard makes personal finance management simple and intuitive:

Track Your Finances

• Add or import your transactions from CGD
• Record expenses across different categories
  • You can create and manage categories
• Monitor your account over time

Generate Reports

• View comprehensive financial reports
• Analyze spending patterns by category and time period

Dashboard Overview

• Get a quick snapshot of your financial health
• See recent transactions at a glance
• Monitor key financial metrics

(back to top)

Roadmap

• Basic income and expense tracking
• Financial goal setting
• Report generation
• Update dependencies
• Replace eslint + prettier with Biome
• Analytics Sections

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make CoinGuard better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Top contributors:

(back to top)

License

Distributed under the MIT License. See LICENSE.md for more information.

(back to top)

Contact

StereoPT - @StereoPT - stereopt@gmail.com

Project Link: https://github.com/StereoPT/coin-guard

(back to top)

Acknowledgments

Special thanks to the following resources and tools that made CoinGuard possible:

• Next.js Documentation
• shadcn/ui Components

(back to top)