OPub Mono

A WIP (work in progress) platform to speed up the development of Open Data Dashboards, aimed at simplifying the process of creating and managing data visualizations, enabling users to easily analyze and present complex data in a user-friendly and accessible way.

Stroybook
Dashboard
Documentation

What's inside?

This repository, built using Turborepo, utilizes Yarn as its package manager and contains the following packages and applications:

Apps and Packages

• apps/www: web application built using the Next.js framework
• apps/docs: documentation site built using Nextra
• packages/opub-ui: a library of reusable React components used in both the web and docs applications.
• packages/eslint-config-custom: eslint configurations for the eslint tool, including eslint-config-next and eslint-config-prettier.
• packages/tsconfig: configuration files for TypeScript used throughout the repository.

Build

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

cd opub-mono
yarn build

Develop

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

cd opub-mono
yarn dev

Develop Only Specific Package

To develop only package, let's say UI, run the following command:

cd opub-mono
yarn dev --filter opub-ui

New Component

Currently this might not working for Linux distros

This repo includes a yarn run new-component module to help create boilerplate for component creation.

yarn run new-component Button

This will create a new component directory in packages/opub-ui/src with required files and also export the component in the index.ts

components/
┣ Button/
┃ ┣ Button.module.scss/
┃ ┣ Button.stories.tsx/
┃ ┣ Button.test.tsx/
┃ ┣ Button.tsx/
┃ ┣ index.ts/