Skip to content

ibimina/streamline-suite-fe

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

86 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

Streamline Suite ๐Ÿš€

A comprehensive business management platform built with modern web technologies. Streamline Suite provides an all-in-one solution for managing quotations, invoices, inventory, expenses, analytics, staff, payroll, and taxes.

โœจ Features

Core Business Modules

  • ๐Ÿ“Š Dashboard - Real-time business metrics and analytics overview
  • ๐Ÿ“ Quotations - Create and manage customer quotations
  • ๐Ÿงพ Invoices - Generate and track invoices
  • ๐Ÿ“ฆ Inventory - Comprehensive inventory management system
  • ๐Ÿ’ฐ Expenses - Track and categorize business expenses
  • ๐Ÿ“ˆ Analytics - Business intelligence and reporting
  • ๐Ÿ‘ฅ Staff Management - Employee management and profiles
  • ๐Ÿ’ต Payroll - Automated payroll processing
  • ๐Ÿงพ Tax Management - Tax calculations and compliance
  • โš™๏ธ Admin Panel - System administration tools
  • ๐Ÿ”ง Settings - Application configuration

Technical Features

  • ๐ŸŽจ Dark/Light Theme - Seamless theme switching with system preference detection
  • ๐Ÿ“ฑ Responsive Design - Mobile-first approach with collapsible sidebar
  • ๐Ÿ” Authentication - Secure login and signup system
  • ๐Ÿ—‚๏ธ State Management - Redux Toolkit for efficient state management
  • ๐ŸŽฏ Modern UI - Clean, intuitive interface with Tailwind CSS
  • โšก Performance - Built with Next.js 16 and React 19 for optimal performance

๐Ÿ› ๏ธ Technology Stack

Frontend Framework

  • Next.js 16.0.1 - React framework with App Router
  • React 19.2.0 - Latest React with concurrent features
  • TypeScript - Type-safe development

State Management

  • Redux Toolkit - Modern Redux for predictable state management
  • React Redux - Official React bindings for Redux

Styling & UI

  • Tailwind CSS v4 - Utility-first CSS framework
  • PostCSS - CSS processing and optimization
  • Heroicons - Beautiful SVG icons
  • Recharts - Composable charting library

Development Tools

  • ESLint - Code linting and quality assurance
  • Hot Reload - Fast development with instant updates

๐Ÿš€ Getting Started

Prerequisites

  • Node.js 18.x or later
  • npm, yarn, pnpm, or bun

Installation

  1. Clone the repository

    git clone <repository-url>
    cd streamline-suite-fe
  2. Install dependencies

    npm install
    # or
    yarn install
    # or
    pnpm install
  3. Run the development server

    npm run dev
    # or
    yarn dev
    # or
    pnpm dev
    # or
    bun dev
  4. Open your browser Navigate to http://localhost:3000 to see the application.

๐Ÿ“ Project Structure

streamline-suite-fe/
โ”œโ”€โ”€ src/
โ”‚   โ”œโ”€โ”€ app/                    # Next.js App Router pages
โ”‚   โ”‚   โ”œโ”€โ”€ (auth)/            # Authentication routes (login, signup)
โ”‚   โ”‚   โ”œโ”€โ”€ (dashboard)/       # Protected dashboard routes
โ”‚   โ”‚   โ”œโ”€โ”€ (public)/          # Public pages (landing, about, etc.)
โ”‚   โ”‚   โ”œโ”€โ”€ globals.css        # Global styles and CSS variables
โ”‚   โ”‚   โ””โ”€โ”€ layout.tsx         # Root layout
โ”‚   โ”œโ”€โ”€ components/            # Reusable UI components
โ”‚   โ”‚   โ”œโ”€โ”€ Dashboard.tsx      # Main dashboard component
โ”‚   โ”‚   โ”œโ”€โ”€ Header.tsx         # Navigation header
โ”‚   โ”‚   โ”œโ”€โ”€ Sidebar.tsx        # Collapsible sidebar navigation
โ”‚   โ”‚   โ”œโ”€โ”€ Icons.tsx          # SVG icon components
โ”‚   โ”‚   โ””โ”€โ”€ ...               # Other business modules
โ”‚   โ”œโ”€โ”€ contexts/             # React Context providers
โ”‚   โ”‚   โ”œโ”€โ”€ CompanyContext.tsx # Company data context
โ”‚   โ”‚   โ””โ”€โ”€ ThemeContext.tsx   # Theme management context
โ”‚   โ”œโ”€โ”€ layouts/              # Layout components
โ”‚   โ”‚   โ”œโ”€โ”€ DashboardLayout.tsx # Dashboard layout wrapper
โ”‚   โ”‚   โ””โ”€โ”€ PublicWebsiteLayout.tsx # Public pages layout
โ”‚   โ”œโ”€โ”€ providers/            # Redux and theme providers
โ”‚   โ”‚   โ”œโ”€โ”€ ReduxProvider.tsx  # Redux store provider
โ”‚   โ”‚   โ””โ”€โ”€ ThemeProvider.tsx  # Theme management provider
โ”‚   โ”œโ”€โ”€ store/                # Redux store configuration
โ”‚   โ”‚   โ”œโ”€โ”€ index.ts          # Store setup and configuration
โ”‚   โ”‚   โ”œโ”€โ”€ hooks.ts          # Typed Redux hooks
โ”‚   โ”‚   โ””โ”€โ”€ slices/           # Redux slices
โ”‚   โ”‚       โ”œโ”€โ”€ authSlice.ts  # Authentication state
โ”‚   โ”‚       โ”œโ”€โ”€ uiSlice.ts    # UI state (theme, sidebar, etc.)
โ”‚   โ”‚       โ””โ”€โ”€ companySlice.ts # Company data state
โ”‚   โ””โ”€โ”€ types.ts              # TypeScript type definitions
โ”œโ”€โ”€ public/                   # Static assets
โ”œโ”€โ”€ tailwind.config.js        # Tailwind CSS configuration
โ”œโ”€โ”€ postcss.config.mjs        # PostCSS configuration
โ”œโ”€โ”€ next.config.mjs           # Next.js configuration
โ”œโ”€โ”€ eslint.config.mjs         # ESLint configuration
โ”œโ”€โ”€ jsconfig.json             # JavaScript/TypeScript configuration
โ””โ”€โ”€ package.json              # Project dependencies and scripts

๐ŸŽจ Theme System

The application features a sophisticated theme system with:

  • Light Theme - Clean, professional light interface
  • Dark Theme - Modern dark interface for low-light environments
  • System Theme - Automatically adapts to user's system preference
  • CSS Variables - Seamless theme switching without page reload
  • Persistent Storage - Theme preference saved in localStorage

Theme Configuration

Themes are managed through Redux state and applied via CSS variables defined in globals.css. The system supports:

  • Custom color palettes for each theme
  • Smooth transitions between themes
  • System preference detection and synchronization

๐Ÿ”ง Development

Available Scripts

  • npm run dev - Start development server with hot reload
  • npm run build - Build production application
  • npm run start - Start production server
  • npm run lint - Run ESLint for code quality

Code Style Guidelines

  • TypeScript First - All new code should be written in TypeScript
  • Component Structure - Use functional components with hooks
  • State Management - Use Redux Toolkit for complex state, local state for simple UI state
  • Styling - Use Tailwind CSS classes, avoid custom CSS when possible
  • File Naming - PascalCase for components, camelCase for utilities

๐Ÿš€ Deployment

Build for Production

npm run build

Deploy on Vercel

The easiest deployment method is using Vercel Platform:

  1. Push your code to a Git repository
  2. Import your project to Vercel
  3. Vercel will automatically detect Next.js and deploy

Other Deployment Options

  • Netlify - Connect your Git repository for automatic deployments
  • AWS Amplify - Deploy with AWS's hosting service
  • Docker - Containerize the application for any cloud provider
  • Static Export - Generate static files for traditional web hosting

๐Ÿ“Š Business Modules

Dashboard

  • Real-time business metrics and KPIs
  • Sales analytics with interactive charts
  • Recent activity feed
  • Low stock alerts and notifications
  • Quick access to all business functions

Quotation Management

  • Professional quotation templates
  • Customer management integration
  • Automatic quotation numbering
  • PDF generation and email delivery
  • Quotation tracking and follow-up

Invoice System

  • Convert quotations to invoices seamlessly
  • Multiple payment method support
  • Automated payment reminders
  • Tax calculations and compliance
  • Revenue tracking and reporting

Inventory Control

  • Real-time stock tracking
  • Low stock alerts and reorder points
  • Product categorization and search
  • Supplier management
  • Inventory valuation reports

๐Ÿค Contributing

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

๐Ÿ“„ License

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

๐Ÿ“ž Support

For support and questions:

  • Create an issue on GitHub
  • Check the documentation
  • Contact the development team

๐Ÿ”ฎ Roadmap

  • Mobile application (React Native)
  • Advanced reporting and analytics
  • Multi-currency support
  • API integrations (accounting software, payment gateways)
  • Multi-tenant architecture
  • Advanced user permissions and roles
  • Real-time collaboration features

Built with โค๏ธ using Next.js, React, and TypeScript

About

Resources

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages