unitycatalog-explorer-legacy

KO | EN

gitlite — search

#python #typescript #react #javascript #config #github-config #nextjs #nodejs #api #rust #linux #docker

unitycatalog-explorer-legacy

★ 13 Open GitHub ↗

Unity Catalog Explorer is a TypeScript + Next.js based Web UI for the Unity Catalog OSS.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Unity Catalog Explorer

Unity Catalog Explorer is a [TypeScript](https://www.typescriptlang.org/) + [Next.js](https://nextjs.org/) +
[Chakra UI](https://v2.chakra-ui.com/) based Web UI for the [Unity Catalog OSS](https://www.unitycatalog.io/).

# Screenshot

# Starting Unity Catalog Explorer Server

As of 2024/06/25, the code implemented in this repository is still a mockup. Additionally, for convenience,
the [Just](https://github.com/casey/just) command runner is being used, but the following steps can also be
executed using [npm](https://www.npmjs.com/) commands. For more details, please check the contents of the
[Justfile](/Justfile).

- Installs the depedendencies and in the [package.json](/package.json) and builds Unity Catalog Explorer:

```bash
  $ just install && just build
  ```

- Starts the Unity Catalog Explorer server:

```bash
  $ just start
  ```

- To start the Unity Catalog server mock, please execute the following command:

```bash
  $ just mock
  ```

# Atomic Design

We have adopted the [Atomic Design Methodology](https://atomicdesign.bradfrost.com/) for structuring UI components,
but some modifications are required. The following list explains the guide-line how to structure of your
components' hierarchy:

- Atoms

According to the original Atomic Design methodology, **_atoms_** can be interpreted as components provided by
  Chakra UI. However, here we define the **_atom_** layer as a layer for re-exporting Chakra UI (for backward
  compatibility) and ensuring compatibility with the Next.js system.

- Molecules

**_Molecules_** are the definition layer of **_atoms_** (according to the original Atomic Design methodology)
  specific to the Unity Catalog Explorer. The difference from the **_organisim_** layer is that the components
  defined here are versatile and relocatable components.

- Organisms

**_Organisms_** can be regarded as identical to **_organisms_** in the original Atomic Design methodology.
  In other words, they are components that define page layouts, such as a navigation bar, and are not
  relocatable within the page.

- Templates / Pages

**_Templates_** and **_pages_** correspond to the [layouts and pages](https://nextjs.org/docs/pages/building-your-application/routing/pages-and-layouts) of Next.js respectively.
  Hence, we don't prepare any designated directories for the **_templates_**' and/or **_pages_**' implementations.

unitycatalog-explorer-legacy

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README