README.md

July 10, 2025 ยท View on GitHub

Memobase Inspector

A modern, feature-rich dashboard application built with Next.js 15 and React 19, designed for efficient management and analysis of MemoBase data. The project supports internationalization and cloud deployment.

Features

  • ๐Ÿš€ Built with Next.js 15 and React 19
  • ๐ŸŒ Internationalization with next-intl
  • ๐ŸŽจ Modern UI components using Radix UI
  • ๐Ÿ“Š Data visualization (e.g., Recharts)
  • ๐ŸŒ™ Dark mode support (next-themes)
  • ๐Ÿ”’ Authentication with Supabase
  • ๐Ÿ’ณ Payment integration with Stripe
  • ๐ŸŽฏ State management with Zustand
  • ๐ŸŽจ Styled with Tailwind CSS
  • ๐Ÿšข Cloudflare deployment support

Prerequisites

  • Node.js (Latest LTS version recommended)
  • pnpm (Package manager)
  • Cloudflare account (for deployment)

Getting Started

  1. Clone the repository:
git clone [repository-url]
cd memobase-inspector
  1. Install dependencies:
pnpm install
  1. Set up environment variables: Create a .env.local file in the root directory and add the required environment variables.

  2. Run the development server:

pnpm dev

Open http://localhost:3000 in your browser to see the result.

Available Scripts

  • pnpm dev - Start the development server (Turbopack)
  • pnpm build - Build the application
  • pnpm start - Start the production server
  • pnpm lint - Run ESLint
  • pnpm preview - Preview Cloudflare build
  • pnpm deploy - Deploy to Cloudflare
  • pnpm upload - Upload build to Cloudflare
  • pnpm cf-typegen - Generate Cloudflare environment types

Project Structure

โ”œโ”€โ”€ app/              # Next.js app directory
โ”œโ”€โ”€ components/       # Reusable UI components
โ”œโ”€โ”€ lib/              # Utility functions and configurations
โ”œโ”€โ”€ types/            # TypeScript type definitions
โ”œโ”€โ”€ messages/         # Internationalization messages
โ”œโ”€โ”€ hooks/            # Custom React hooks
โ”œโ”€โ”€ public/           # Static assets
โ”œโ”€โ”€ api/              # API routes
โ””โ”€โ”€ utils/            # Business utilities

Deployment

Deploy to Cloudflare with a single command:

pnpm deploy

Contributing

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

License

This project is based on Memobase and follows its original license. Please refer to the original Memobase repository for license details.

Support

For support, please open an issue in the repository.