Skip to content

subhangR/Dute

Repository files navigation

Clockwork - Compliance Reminder System

A modern web application for Chartered Accountants and Company Secretaries to automate compliance reminder delivery to their clients.

Features

  • User Authentication - Login, Signup, and Password Reset
  • 👥 Client Management - Add, edit, view, and manage clients
  • 📋 Compliance Tracking - Assign and track statutory compliances
  • 📅 Due Date Management - Automatic due date calculation and tracking
  • 🔔 Automated Reminders - Email reminders 7 days before due dates
  • 📊 Dashboard - Overview of upcoming due dates and statistics
  • 📤 Bulk Import - Import multiple clients via Excel/CSV
  • ⚙️ Settings - Configure profile and email preferences

Tech Stack

  • Frontend: React 18 + TypeScript
  • Build Tool: Vite
  • Styling: Tailwind CSS
  • UI Components: Custom shadcn/ui inspired components
  • Routing: React Router v6
  • Icons: Lucide React
  • Date Handling: date-fns

Getting Started

Prerequisites

  • Node.js >= 18.0.0
  • npm or pnpm

Installation

  1. Install dependencies:
npm install
  1. Start the development server:
npm run dev
  1. Open your browser and navigate to:
http://localhost:5173

Build for Production

npm run build

The built files will be in the dist directory.

Preview Production Build

npm run preview

Project Structure

src/
├── components/
│   ├── ui/              # Reusable UI components
│   └── layout/          # Layout components (AppLayout, AuthLayout)
├── pages/
│   ├── auth/            # Authentication pages
│   ├── dashboard/       # Dashboard page
│   ├── clients/         # Client management pages
│   ├── compliances/     # Compliance pages
│   ├── due-dates/       # Due date pages
│   ├── reminders/       # Reminder history
│   └── settings/        # Settings pages
├── data/                # Mock data
├── types/               # TypeScript type definitions
├── lib/                 # Utility functions
└── App.tsx              # Main app component with routing

Available Routes

Public Routes

  • /auth/login - Login page
  • /auth/signup - Signup page
  • /auth/forgot-password - Forgot password page

Protected Routes

  • /dashboard - Main dashboard
  • /clients - Client list
  • /clients/new - Add new client
  • /clients/:id - Client details
  • /clients/:id/edit - Edit client
  • /clients/import - Bulk import clients
  • /compliances - Compliance list
  • /compliances/client/:clientId - Manage client compliances
  • /due-dates - Due dates list
  • /due-dates/:id - Due date details
  • /reminders - Reminder history
  • /settings/profile - Profile settings
  • /settings/email - Email settings

Mock Data

The application currently uses mock data for demonstration purposes. Mock data includes:

  • 3 sample clients
  • 10 compliance types (GST, TDS, ROC, etc.)
  • 5 due dates
  • 4 reminder logs

Supported Organization Types

  • Private Limited Company
  • Public Limited Company
  • One Person Company (OPC)
  • Partnership Firm
  • Limited Liability Partnership (LLP)
  • Section 8 Company
  • Trust
  • Society
  • Individual/Proprietorship
  • Foreign Company

Compliance Categories

  • GST: GSTR-1, GSTR-3B, etc.
  • TDS: TDS Payment, TDS Returns (24Q, 26Q, 27Q)
  • Payroll: PF Payment, ESI Payment
  • ROC/MCA: MGT-7, AOC-4, DIN KYC
  • Income Tax: ITR Filing, Tax Audit

Future Enhancements

  • Firebase backend integration
  • Real-time data synchronization
  • Email automation via SendGrid/Resend
  • SMS/WhatsApp reminders
  • Advanced reporting and analytics
  • Multi-user firm access
  • Client portal
  • Mobile app (React Native)

Development Notes

  • The application is currently in UI-only mode with mock data
  • Authentication is simulated (always authenticated)
  • Form submissions log to console
  • Backend integration pending

Documentation

For detailed documentation, see the docs/ directory:

  • 01-clarifying-questions.md - Design clarifications
  • 02-requirements-analysis.md - Functional requirements
  • 03-domain-model-and-types.md - Data models
  • 04-ui-flows-and-screens.md - UI specifications
  • 05-scheduling-architecture-and-integrations.md - Backend architecture
  • 06-technical-implementation-guide.md - Implementation guide

License

Proprietary

Contact

For questions or support, please contact the development team.

About

CA app

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors