Lilypad-Tech / web-ui

UIs and website that are accessed with a browser
Apache License 2.0
3 stars 0 forks source link
hacktoberfest hacktoberfest-accepted

Lilypad web uis

This repo contains the Lilypad UIs reachable via a browser or node based. Each UI is seperated into it's own pnpm workspace, see details in ## Project structure below.

Prerequisites

Development stack

Project structure

Apps

Packages

Styling

The tailwind preset used throughout all workspaces in this repo relies heavily on npm package @frontline-hq/uui-tailwind, which provides a lot of useful tailwind utilities for Untitled UI 4.0.

Additionally, the (!private) npm package @frontline-hq/uui-foundations-assets is used to provide Untitled UI 4.0 icons that can be easily used.

The npm access token is made available via doppler.

UI

All UI's are prototyped in Figma.

Local development

Make sure you have access to the doppler project and configuration and have run doppler setup.

Run the following command for setting things up:

npm run boot

Use the following command to execute a local server to serve and hot-reload the given app:

npm run dev <app-name>

This will run the Next.js app located at ./apps/<app-name>.

Git flow conventions Please follow these conventions when working on this repo.

Deployment

The git branch main is automatically deployed:

Staging

The git branch staging is automatically made available via staging:

Current state of development

Development on this repo is currently paused but will be continued shortly.

Several features that are prototyped in Figma are already implemented waiting for API endpoints from the backend to be made available.

The corresponding code to these UI elements has been commented out and can therefore easily be added to production.

Notes

On workspaces

This is a monorepo utilizing nx and pnpm workspaces. That implies:

Ensure that the app-name property in the package.json matches the name you use in the command to run the application. For instance, if the app-name property in package.json is info-dashboard, you should use info-dashboard in the command as well (npm run dev info-dashboard).

A good read to understand nx and pnpm workspaces and the capabilities: https://dev.to/nx/setup-a-monorepo-with-pnpm-workspaces-and-speed-it-up-with-nx-1eem#installing-nx