@geenius/roadmap

Public roadmap, voting, comments, and admin tooling for Geenius products.

Overview

@geenius/roadmap packages the shared roadmap data model, framework bindings, CSS variants, and Convex helpers behind a stable root export map. It is designed for feature-roadmap pages, detail drawers, voting flows, and admin review tools.

Installation

pnpm add @geenius/roadmap

Add the peers you actually use:

• react and react-dom for @geenius/roadmap/react or @geenius/roadmap/react-css
• solid-js for @geenius/roadmap/solidjs or @geenius/roadmap/solidjs-css
• convex for @geenius/roadmap/convex

Subpath Imports

import { getCategoryEmoji } from '@geenius/roadmap'
import { getCategoryEmoji } from '@geenius/roadmap/shared'
import { schema, listItems, toggleVote } from '@geenius/roadmap/convex'
import { RoadmapPage, RoadmapDetailPage, RoadmapAdminPage } from '@geenius/roadmap/react'
import { RoadmapPage as RoadmapCssPage } from '@geenius/roadmap/react-css'
import { createRoadmap } from '@geenius/roadmap/solidjs'
import { RoadmapPage as RoadmapSolidCssPage } from '@geenius/roadmap/solidjs-css'

Public Subpaths

• @geenius/roadmap and @geenius/roadmap/shared expose the framework-agnostic roadmap contract.
• @geenius/roadmap/react exposes Tailwind-based React hooks, components, and pages.
• @geenius/roadmap/react-css exposes standalone React components and pages backed by vanilla CSS.
• @geenius/roadmap/solidjs exposes Tailwind-based SolidJS primitives, components, and pages.
• @geenius/roadmap/solidjs-css exposes standalone SolidJS components and pages backed by vanilla CSS.
• @geenius/roadmap/convex exposes the typed Convex schema, queries, and mutations.

The CSS variant entrypoints import their own stylesheets, so consumers only need the package subpath import.

Usage

import { RoadmapPage } from '@geenius/roadmap/react'

export function ProductRoadmapRoute() {
  return <RoadmapPage />
}

import { configureRoadmap } from '@geenius/roadmap'
import { RoadmapPage } from '@geenius/roadmap/react-css'

configureRoadmap({
  enabled: true,
  apiBasePath: '/api/roadmap',
  publicVoting: true,
  votesPerUser: 1,
  allowComments: true,
  showCompletedItems: true,
  linkedToChangelog: false,
})

export function ProductRoadmapCssRoute() {
  return <RoadmapPage />
}

import { createRoadmap } from '@geenius/roadmap/solidjs'

export function SolidRoadmapExample() {
  const roadmap = createRoadmap()
  return <div>{roadmap.items().length}</div>
}

Convex Example

import schema, { listItems, toggleVote } from '@geenius/roadmap/convex'

export { schema, listItems, toggleVote }

Storybook

Reference Storybook apps for both frameworks live in the package repository:

• React Storybook app
• SolidJS Storybook app

Both surfaces render the Tailwind and vanilla CSS variants side by side for parity review.

License

Free-tier usage is licensed under FSL-1.1-Apache-2.0. Commercial usage follows the Geenius commercial license terms.

See LICENSE.