Note: This project started as a learning exercise to create modern dashboards. However, it gradually moved away from the original idea, so I decided to pivot and start fresh. You can check the original approach here: https://github.com/synqcloud/synq

Synq is a modern inventory and sales management system designed for individual online sellers. Built for simplicity and efficiency, it helps you track your inventory, manage sales across different platforms, and gain insights into your business performance.

Features

• 📦 Simple Inventory Tracking – Monitor stock levels and product details
• 📊 Sales Overview – Track sales across different platforms
• 💰 Basic Profitability – Calculate costs and revenue
• 🔄 Data Import/Export – Easy migration from spreadsheets
• 📈 Basic Reports – Generate simple financial insights

Tech Stack

• Frontend:

  • Next.js
  • React
  • TypeScript
  • Tailwind CSS
  • Shadcn UI components
  • React Query for data fetching
  • React Hook Form with Zod validation
  • Recharts for data visualization

• Backend:

  • Next.js API Routes
  • Supabase for authentication and database

• Development:

  • Turborepo for monorepo management
  • ESLint and Prettier for code quality
  • TypeScript for type safety

Project Structure

synq/
├── apps/                    # Applications
│   ├── web/                 # Next.js web application (port 3000)
│   └── desktop/             # Desktop application (port 3001)
├── packages/                # Shared packages
│   ├── ui/                  # Shared UI components
│   ├── supabase/            # Supabase client and utilities
│   ├── eslint-config/       # Shared ESLint configuration
│   └── typescript-config/   # Shared TypeScript configuration
├── infra/                   # Supabase for Local Development
│   ├── supabase/        
└── .github/                 # GitHub workflows and templates

Getting Started

Prerequisites

• Node.js 20.9.0 or later
• Yarn 1.22.19 or later
• Docker Desktop installed and running
• Supabase CLI installed (see official documentation for installation methods)

Installation

1. Clone the repository:

   git clone https://github.com/yourusername/synq.git
   cd synq

2. Install dependencies:

   yarn install

3. Start Local Supabase:

   cd infra && supabase start

   This will start the local Supabase instance and output your API credentials.

4. Set up environment variables:

   cp apps/web/.env.example apps/web/.env.local

   Edit apps/web/.env.local with the values from the Supabase start output:

   • NEXT_PUBLIC_SUPABASE_URL: http://localhost:54321
   • NEXT_PUBLIC_SUPABASE_ANON_KEY: Your anon key from the Supabase start output

5. Reset the database (if needed):

   cd infra && supabase db reset

   This will run migrations and seed the database with test data.

6. Start the development server:

   yarn dev

The application will be available at:

• Web Application: http://localhost:3000
• Supabase Dashboard: http://localhost:54323
• Auth Emails: http://localhost:54324

Development Scripts

• yarn dev - Start development server with Turbopack
• yarn build - Build the application
• yarn start - Start production server
• yarn lint - Run ESLint
• yarn format - Format code with Prettier
• yarn generate-types - Generate Supabase database types

Troubleshooting

If you encounter issues:

1. Ensure Docker Desktop is running
2. Check Supabase status:

   cd infra && supabase status

3. Restart Supabase if needed:

   cd infra && supabase start

4. Reset the database:

   cd infra && supabase db reset

5. Verify your environment variables in .env.local

License

This project is licensed under the AGPL-3.0 for non-commercial use.