OberonCMS

A monorepo for OberonCMS and the related packages and tooling.

Quick start

We use pNpm for workspace support - if you choose to use npm or yarn ymmv.

pnpm install

pnpm dev:oberon # Develop OberonCMS and all dependencies using the playground.

pnpm dev:demo # Develop the demo app and all dependencies.

pnpm dev:docs # Develop the documentation.

pnpm dev:rich-text-demo # Develop the rich text demo app and all dependencies.

pnpm tsc # Typecheck

pnpm lint:fix # Run eslint, fixing any issues

pnpm prettier:fix # Run prettier, fixing any issues

pnpm build # Build all packages

pnpm change # Add a changset entry

What's inside?

This Turborepo that includes the following packages and apps:

Apps

• apps/documentation - https://oberoncms.com

  Landing page and documentation for OberonCMS.

  Includes a demo app.

• apps/playground

  A playground for developers to test OberonCMS.

  Mostly used for local development, there is also a deployment with access limited to core contributors.

• apps/rich-text-demo - https://puck-rich-text.tohuhono.com

  an app demoing puck-rich-text

Packages

OberonCMS

• packages/create-oberon-app - create-oberon-app

  A command line tool for creating new projects with OberonCMS.

• packages/oberoncms/core - @oberoncms/core

  The core package for OberonCMS.

• packages/oberoncms/sqlite - @oberoncms/sqlite

  Sqlite adapter for OberonCMS.

Plugins

• packages/plugins/developement - @oberoncms/plugin-development

  Provides local only adapters for development.

• packages/plugins/turso - @oberoncms/plugin-turso

  A Turso libsql database plugin for OberonCMS.

• packages/plugins/pgsql - @oberoncms/plugin-pgsql

  A PostgreSQL database plugin for OberonCMS.

• packages/plugins/vercel-postgres - @oberoncms/plugin-vercel-postgres

  A Vercel PostgreSQL database plugin for OberonCMS.

• packages/plugins/uploadthing - @oberoncms/plugin-uploadthing

  An Puck component and OberonCMS plugin for embeding uploadthing images.

• packages/plugins/flydrive - @oberoncms/plugin-flydrive

  A plugin that provides an Image component and storage using flydrive.

Utilities and Config

• packages/tohuhono/dev - @tohuhono/dev

  Base config and scripts for building packages and apps.

  • TypeScript for static type checking
  • ESLint for code linting
  • Prettier for code formatting
  • Vite for bundling

• packages/tohuhono/utils - @tohuhono/utils

  A collection of utility functions shared across the monorepo. Particularly useful for testing.

• packages/tohuhono/ui - @tohuhono/ui

  Shared UI components using Shadcn/ui and utilities including a tailwindcss theme and components for dynamicaly loading and adjusting it.

Puck components

• packages/tohuhono/puck-rich-text - @tohuhono/puck-rich-text

  A puck component for rich text editing made for OberonCMS.

• packages/tohuhono/puck-blocks - @tohuhono/puck-blocks

  A collection of puck components for building pages in OberonCMS, including a collection of example Puck components.

Recipes

Used by the create-oberon-app command. If you would like to support other frameworks, please get in touch as we would love to help.

• recipes/nextjs

  A Next.js starter app.

Contributing

OberonCMS is an open source project and we welcome contributions from the community. You can raise an issue or submit a pull request to help us improve.

1. Fork and clone the repository
2. Ensure you have the LTS version of Node.js installed, as well as the latest version of pnpm.
3. Install the project dependencies by running pnpm install.
4. Implement your changes, as well as any documentation or tests that are required.
5. Create a changeset for your changes by running pnpm changeset.
6. Open a pull request with your changes and changeset.

What next?

We are under heavy development, building out the core capabilities. Check out our todo list for upcoming features.

Contributors

Jon Vivian

Ahmed Rowaihi

turbobot-temp

oberoncms