OpenCode Inventory

A modern frontend application to serve documentation and manage OpenCode skills, plugins, and hooks.

Features

• 📚 Documentation Viewer: Browse all documentation from the frontend/docs/ directory.
• 📱 Mobile Friendly: Responsive design for all devices.
• 🔍 Inventory Search (Coming Soon): Search and explore Skills, Plugins, and Hooks.

Getting Started (Local Development)

Prerequisites

• Node.js 18+
• npm, yarn, or pnpm

Steps

1. Navigate to the frontend directory:

   cd frontend

2. Install dependencies:

   npm install
   # or
   yarn install

3. Run the development server:

   npm run dev
   # or
   yarn dev

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

Deployment

Option 1: Vercel (Recommended)

The easiest way to deploy is to use the Vercel Platform.

1. Push your code to a Git repository (GitHub, GitLab, BitBucket).
2. Import the project into Vercel.
3. In the "Configure Project" step:
   • Set Framework Preset to Next.js.
   • Set Root Directory to frontend.
4. Click Deploy.

Option 2: Docker

You can self-host using Docker and Docker Compose.

1. Navigate to the deployment folder:

   cd deployment/docker

2. Start the application:

   docker-compose up -d

3. Open http://localhost:3000.

Directory Structure

• frontend/: The Next.js application source code.
  • docs/: Markdown documentation files (Skills, Plugins, Hooks).
  • src/: React components and logic.
• deployment/: Configuration files for Docker deployment.