diff --git a/README.md b/README.md index 05de59d..dca8604 100644 --- a/README.md +++ b/README.md @@ -1,34 +1,19 @@ -# Mint +# Mint: Your Personal Finance Assistant (Node.js) [![Mint tests Status](https://github.com/treyhboy/Mint/workflows/Mint%20tests/badge.svg)](https://github.com/treyhboy/Mint/actions) -A barebones Node.js app using [Express 4](http://expressjs.com/). - -## Running Locally +## Take control of your finances with Mint, a modern and secure personal finance app built using Node.js and Express. Get real-time insights into your spending, manage bills, track progress towards goals, and access valuable financial tools - all in one convenient place. -Pull down repository - -```sh -git clone https://github.com/treyhboy/Mint.git # or clone your own fork -cd Mint -``` - -Make sure you have [Node.js](http://nodejs.org/) and [MySQL](https://dev.mysql.com/downloads/mysql/) installed. - -```sh -npm install -npm start -``` - -You can also use Docker to run the app. This will remove the requirement of MySQL installed on your local machine and will run MySQL in a Docker container. - -```sh -docker-compose up -d -``` +A barebones Node.js app using [Express 4](http://expressjs.com/). -Your app should now be running on [localhost:3100](http://localhost:3100/). +## Key Features: +* Seamless Data Aggregation: Connect securely to bank accounts, credit cards, and investment accounts for a comprehensive overview of your financial health. +* Automated Categorization: Mint automatically categorizes your transactions, saving you time and effort. +* Intuitive Budgeting: Set and track personalized budgets to see where your money goes and stay on top of your financial goals. +* Powerful Insights: Gain actionable insights into your spending habits, track your credit score, and receive personalized financial guidance. +* User-Friendly Interface: Navigate Mint's clean and intuitive interface with ease, whether on your desktop or mobile device. -## Screenshots from the app +## Screenshots ### About Page @@ -46,16 +31,41 @@ Your app should now be running on [localhost:3100](http://localhost:3100/). ![working page](Screenshots/working%20page.png) -## How it Works -Manage your money like never before! +## Running Locally + +1. Clone the Repository: + +```sh +git clone https://github.com/treyhboy/Mint.git # or clone your own fork +cd Mint +``` + +2. Install Dependencies: [Node.js](http://nodejs.org/) and [MySQL](https://dev.mysql.com/downloads/mysql/) + +```sh +npm install +``` +3. Run the App +```sh +npm start +``` +You can also use Docker to run the app. This will remove the requirement of MySQL installed on your local machine and will run MySQL in a Docker container. + +```sh +docker-compose up -d +``` + +Access your app at http://localhost:3100. -We bring together everything from balances and bills to your credit score and more. It’s your financial life, in one place that’s easy to understand. +## Contributing: -Mint tracks and categorizes your information. From your bank accounts and credit cards to retirement accounts and more -we’ll crunch the numbers as they happen, so you know where you stand. +We welcome contributions to help Mint grow and improve! Feel free to: -It’s free and easy to get started, and we connect to almost every Indian financial institution connected to the internet. In just minutes, you’ll see where your money is going and get ideas on how to stretch it farther. +* Create issues for bug reports or feature suggestions. +* Submit pull requests with code changes and enhancements. +* Share your ideas and feedback for future development. -## Contribution +## Community: -Some UI changes to the app would be great for going and some feature enhances. +Join our community of users and developers to discuss Mint, share your experiences, and help each other make the most of the app.