Skip to content

cvsuhail/HighRangeStarApp

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

18 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

🌟 High Range Star - Document Management Platform

Streamline Your Business Operations with Intelligent Document Management

High Range Star is a comprehensive Next.js-based document management platform designed specifically for businesses that handle complex quotation workflows, purchase orders, delivery notes, and invoicing processes. Built with modern web technologies and Firebase integration, it provides a seamless experience for managing business documents and operations.

Version Next.js Firebase TypeScript

✨ Key Features

πŸ“‹ Comprehensive Document Management

  • Quotation Management: Create, edit, and track quotations with version control
  • Purchase Order Processing: Handle purchase orders with automated workflows
  • Delivery Notes: Manage delivery documentation with digital signatures
  • Invoice Generation: Automated invoice creation and tracking
  • Thread-based Organization: Group related documents for better organization

🏒 Business Operations

  • Vessel Management: Complete CRUD operations for vessel information
  • Customer Management: Track customer data and interactions
  • Template System: Pre-built quotation templates for quick generation
  • Status Tracking: Real-time status updates for all business processes

πŸ“Š Analytics & Reporting

  • Interactive Dashboard: Comprehensive overview of business metrics
  • Sales Analytics: Monthly sales charts and performance tracking
  • Statistics Visualization: Advanced charts and graphs using ApexCharts
  • Demographic Insights: Customer and market analysis tools
  • Recent Orders: Quick access to latest transactions

πŸ” Security & Authentication

  • Firebase Authentication: Secure user login and session management
  • Role-based Access: Admin and user permission systems
  • Data Validation: Client and server-side validation
  • Secure File Upload: Protected document storage and retrieval

🎨 Modern User Experience

  • Responsive Design: Optimized for desktop, tablet, and mobile
  • Dark/Light Theme: Toggle between themes with persistent preferences
  • Intuitive Navigation: Collapsible sidebar with smooth animations
  • Real-time Updates: Live data synchronization across the platform
  • Drag & Drop: Easy file uploads and document management

πŸ› οΈ Technology Stack

Frontend

  • Next.js 15.2.3 - React framework with App Router
  • React 19 - Latest React with concurrent features
  • TypeScript 5.0 - Type-safe development
  • Tailwind CSS 4.0 - Utility-first styling framework
  • ApexCharts - Interactive data visualization
  • React DnD - Drag and drop functionality

Backend & Database

  • Firebase 12.3.0 - Backend-as-a-Service
  • Firestore - NoSQL document database
  • Firebase Auth - User authentication
  • Firebase Analytics - Usage tracking

Development Tools

  • ESLint - Code linting and quality
  • Prettier - Code formatting
  • PostCSS - CSS processing
  • SVGR - SVG optimization

πŸš€ Quick Start

Prerequisites

  • Node.js 18+
  • npm or yarn
  • Firebase project

Installation

  1. Clone the repository

    git clone <repository-url>
    cd HighRangeStarApp-main
  2. Install dependencies

    npm install
    # or
    yarn install
  3. Firebase Setup

    • Create a Firebase project at Firebase Console
    • Enable Firestore Database
    • Configure Firebase Auth
    • Update src/lib/firebase.ts with your project credentials
  4. Environment Configuration

    cp .env.example .env.local
    # Add your Firebase configuration
  5. Run the development server

    npm run dev
    # or
    yarn dev
  6. Open your browser Navigate to http://localhost:3000

πŸ“ Project Structure

src/
β”œβ”€β”€ app/                    # Next.js App Router
β”‚   β”œβ”€β”€ (admin)/           # Admin dashboard pages
β”‚   β”œβ”€β”€ (full-width-pages)/ # Authentication and error pages
β”‚   └── layout.tsx         # Root layout
β”œβ”€β”€ components/            # Reusable UI components
β”‚   β”œβ”€β”€ auth/             # Authentication components
β”‚   β”œβ”€β”€ charts/           # Data visualization
β”‚   β”œβ”€β”€ ecommerce/        # Dashboard widgets
β”‚   β”œβ”€β”€ form/             # Form components
β”‚   β”œβ”€β”€ quotation/        # Quotation-specific components
β”‚   └── ui/               # Base UI components
β”œβ”€β”€ context/              # React Context providers
β”‚   β”œβ”€β”€ AuthContext.tsx   # Authentication state
β”‚   β”œβ”€β”€ ThemeContext.tsx  # Theme management
β”‚   β”œβ”€β”€ QuotationStore.tsx # Business logic
β”‚   └── SidebarContext.tsx # Navigation state
β”œβ”€β”€ hooks/                # Custom React hooks
β”œβ”€β”€ icons/                # SVG icon components
β”œβ”€β”€ layout/               # Layout components
β”œβ”€β”€ lib/                  # Utility libraries
β”‚   β”œβ”€β”€ firebase.ts       # Firebase configuration
β”‚   └── vesselService.ts  # Vessel operations
└── types/                # TypeScript type definitions

πŸ”§ Configuration

Firebase Setup

Detailed Firebase configuration guide available in FIREBASE_SETUP.md

Security Rules

Production-ready security rules documented in firestore-security-rules.md

πŸ“± Features Overview

Dashboard

  • Real-time Metrics: Customer count, order statistics
  • Sales Analytics: Monthly sales charts and trends
  • Performance Tracking: Visual statistics and KPIs
  • Quick Actions: Fast access to common operations

Document Management

  • Quotation Workflow: Create β†’ Review β†’ Accept/Decline β†’ Revise
  • Purchase Orders: Upload and track purchase documentation
  • Delivery Notes: Generate and manage delivery documentation
  • Invoice Generation: Automated invoice creation from quotations

Vessel Management

  • CRUD Operations: Complete vessel information management
  • Search & Filter: Advanced search capabilities
  • Validation: Data integrity and duplicate prevention
  • Responsive Interface: Mobile-optimized vessel management

🎯 Business Workflow

  1. Create Quotation β†’ Customer receives quote
  2. Customer Response β†’ Accept/Decline/Request Changes
  3. Purchase Order β†’ Upload customer PO documents
  4. Delivery Planning β†’ Generate delivery notes
  5. Invoice Generation β†’ Create final invoice
  6. Completion β†’ Mark thread as completed

πŸ”’ Security Features

  • Authentication: Firebase Auth with email/password
  • Authorization: Role-based access control
  • Data Validation: Client and server-side validation
  • Secure Storage: Firebase Firestore with security rules
  • Session Management: Persistent and temporary sessions

πŸ“Š Analytics & Monitoring

  • Firebase Analytics: User behavior tracking
  • Performance Metrics: Application performance monitoring
  • Error Tracking: Automated error reporting
  • Usage Statistics: Feature utilization analytics

🎨 UI/UX Features

  • Responsive Design: Mobile-first approach
  • Dark Mode: Toggle between light and dark themes
  • Smooth Animations: Enhanced user experience
  • Accessibility: WCAG compliance considerations
  • Modern Components: Latest UI patterns and interactions

πŸš€ Deployment

Production Build

npm run build
npm start

Firebase Deployment

firebase deploy

Environment Variables

Local Development Setup

  1. Copy the example environment file:

    cp .env.example .env.local
  2. Update .env.local with your Firebase configuration:

    # Firebase Configuration
    NEXT_PUBLIC_FIREBASE_API_KEY=your_api_key_here
    NEXT_PUBLIC_FIREBASE_AUTH_DOMAIN=your_project_id.firebaseapp.com
    NEXT_PUBLIC_FIREBASE_PROJECT_ID=your_project_id
    NEXT_PUBLIC_FIREBASE_STORAGE_BUCKET=your_project_id.firebasestorage.app
    NEXT_PUBLIC_FIREBASE_MESSAGING_SENDER_ID=your_sender_id
    NEXT_PUBLIC_FIREBASE_APP_ID=your_app_id
    NEXT_PUBLIC_FIREBASE_MEASUREMENT_ID=your_measurement_id

Production Environment Variables

Configure these environment variables in your production environment:

  • NEXT_PUBLIC_FIREBASE_API_KEY
  • NEXT_PUBLIC_FIREBASE_AUTH_DOMAIN
  • NEXT_PUBLIC_FIREBASE_PROJECT_ID
  • NEXT_PUBLIC_FIREBASE_STORAGE_BUCKET
  • NEXT_PUBLIC_FIREBASE_MESSAGING_SENDER_ID
  • NEXT_PUBLIC_FIREBASE_APP_ID
  • NEXT_PUBLIC_FIREBASE_MEASUREMENT_ID

⚠️ Security Note: Never commit .env.local or any file containing actual API keys to version control.

🀝 Contributing

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

πŸ“„ License

This project is proprietary software. All rights reserved.

πŸ“ž Support

For support and questions:

  • Create an issue in the repository
  • Contact the development team
  • Check the documentation in the /docs folder

AwwAds Built with ❀️ for modern business operations

About

Document Management Simplify App

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors