Coconut Shake Financial Tracker

Project is under development, please refer TODO.md

Overview

The Coconut Shake Financial Tracker is a web-based application designed to help small business owners, specifically roadside coconut shake stall operators, manage and track their daily cash flow. This application provides an easy-to-use interface for recording income, expenses, and generating financial reports.

Features

• Daily cash inflow tracking
• Weekly expense recording with categorization
• Visual dashboard for financial data representation
• Reporting and analysis tools
• Data export functionality

Technology Stack

• Frontend: Vue.js 3 with Nuxt 3 framework
• State Management: Pinia
• UI Components: Nuxt UI
• Charts: Chart.js
• Styling: Tailwind CSS

Prerequisites

• Node.js (version 18 or higher)
• npm (latest stable version) or yarn (latest stable version)

Installation

1. Clone the repository:

   git clone https://github.com/AzraiHasan/coconut-shake-financial-tracker.git
   

2. Navigate to the project directory:

   cd coconut-shake-financial-tracker
   

3. Install dependencies:

   npm install
   # or
   yarn install
   

Running the Application

To run the application in development mode:

npm run dev
# or
yarn dev

The application will be available at http://localhost:3000.

Building for Production

To build the application for production:

npm run build
# or
yarn build

Testing

No unit test implemented yet.

Contributing

We welcome contributions to the Coconut Shake Financial Tracker! Please read our CONTRIBUTING.md file for details on our code of conduct and the process for submitting pull requests.

License

This project is licensed under the MIT License.

Contact

If you have any questions or feedback, please open an issue in the GitHub repository.

---

Thank you for your interest in the Coconut Shake Financial Tracker project!