📒 Ledger

Ledger is a comprehensive web application designed to streamline shop management for shopkeepers. With features like customer management, expense tracking, invoice generation, payment tracking, and detailed sales analytics, Ledger aims to simplify and enhance the daily operations of small businesses.

✨ Features

• Customer Management: Maintain detailed customer profiles and track their purchase history.
• Expense Management: Keep an accurate record of all operational expenses.
• Invoice/Bill Generation: Generate invoices for one or multiple items, supporting both GST and non-GST bills.
• Payment Tracking: Monitor payments received and made, with detailed transaction records.
• Dashboard: Visualize monthly and daily sales data through an intuitive dashboard.
• Profit Tracking: Analyze profits on a daily, monthly, and weekly basis.
• User Authentication: Secure user login and registration, ensuring data privacy and protection.

🛠 Tech Stack

• Frontend: React, Tailwind CSS, Material-UI
• Backend: Node.js, Express.js
• Database: MongoDB, PostgreSQL
• Authentication: Firebase Authentication (optional)

📁 Project Structure

ledger/
├── backend/
│   ├── controllers/
│   ├── models/
│   ├── routes/
│   ├── utils/
│   ├── .env
│   ├── app.js
│   └── server.js
├── frontend/
│   ├── public/
│   ├── src/
│   │   ├── components/
│   │   ├── pages/
│   │   ├── styles/
│   │   ├── App.js
│   │   └── index.js
├── .gitignore
├── README.md
├── package.json
└── package-lock.json

🚀 Getting Started

Prerequisites

• Node.js (v14 or higher)
• npm (v6 or higher)
• MongoDB
• PostgreSQL

Backend Setup

1. Clone the repository:

   git clone https://github.com/yourusername/ledger.git
   cd ledger/backend

2. Install dependencies:

   npm install

3. Create a .env file in the backend directory and add the following:

   PORT=5000
   MONGO_URI=your_mongodb_uri
   POSTGRES_URI=your_postgresql_uri
   JWT_SECRET=your_jwt_secret

4. Run the backend server:

   npm start

Frontend Setup

1. Navigate to the frontend directory:

   cd ledger/frontend

2. Install dependencies:

   npm install

3. Run the frontend server:

   npm start

Running the Project

1. Ensure MongoDB and PostgreSQL are running.

2. Start the backend server (in backend directory):

   npm start

3. Start the frontend server (in frontend directory):

   npm start

4. Open your browser and navigate to:

   http://localhost:3000

🌟 Contributing

We welcome contributions from the community! To get started:

1. Fork the repository: Click on the 'Fork' button at the top right of this page.

2. Clone your fork:

   git clone https://github.com/yourusername/ledger.git

3. Create a new branch:

   git checkout -b feature-branch

4. Make your changes: Add new features, fix bugs, improve documentation.

5. Commit your changes:

   git commit -am 'Add new feature'

6. Push to your branch:

   git push origin feature-branch

7. Open a pull request: Go to the original repository and click the 'New pull request' button.

📄 License

This project is licensed under the MIT License. See the LICENSE file for details.

📬 Contact

For any inquiries, please contact priyans-hu.

💖 Support

If you like this project, please consider giving it a ⭐ on GitHub!