datum-ui

This is the Datum UI monorepo. This repo is intended to help our teams and developers speed up development while building sustainable and low carbon footprint user interfaces.

What's inside?

This monorepo is run on Bun and built using Turborepo. It includes the following packages/apps:

Apps and Packages

• docs: susUI docs repo https://docs.sus-ui.datum.net/
• operator: Datum Operator Portal https://console.datum.net/
• @repo/ui: susUI component library shared by our other applications
• @repo/dally: DAL library for sharing common patterns and functionality in our other apps
• @repo/eslint-config: eslint configurations (includes eslint-config-next and eslint-config-prettier)
• @repo/typescript-config: tsconfig.jsons used throughout the monorepo

Each package/app is 100% TypeScript.

Stack

Our team using this stack for our Turborepo:

• Bun to bundle, dev, test, deploy and run apps
• TypeScript for static type-checking
• ESLint for code linting
• Prettier for code formatting
• Next.js the React frame for the web
• React for creating user interfaces
• SWR for client-side data fetching, caching, and de-deduping API requests
• HeadlessUI for headless accessibility-compliant components
• Tailwindcss for styles without leaving TSX syntax

Prerequisites

Datum suggests using Bun for its speed and versatility, however, Turborepo supports many of the common package managers such as npm, yarn, or pnpm.

To install Bun run:

curl -fsSL https://bun.sh/install | bash

Build

To build all apps and packages, run the following command:

bun run build

Develop

1. Copy the .env, this is in .gitignore so you do not have to worry about accidentally committing it. This hold example of environment configurations which you should review and potentially override depending on your needs.

   cp ./config/.env-example ./config/.env

2. To develop all apps and packages, run the following command:

   bun install
   bun dev

Alternatively, you can run a single repo instead of all the repos with the filter argument:

For example to develop on the docs app only run:

bun dev --filter docs