Skip to content

checkmarble/marble-frontend

Folders and files

NameName
Last commit message
Last commit date
Mar 8, 2024
Dec 18, 2023
Apr 9, 2024
Feb 7, 2024
Mar 8, 2024
Nov 23, 2022
Jan 2, 2024
Feb 13, 2024
Oct 25, 2023
Jan 19, 2024
Jan 3, 2024
Mar 8, 2024
Mar 8, 2024
Jan 23, 2024
Jan 31, 2024
Feb 13, 2024
Feb 29, 2024
Feb 29, 2024
Jul 18, 2023
Jan 2, 2024
Jan 2, 2024
Jul 11, 2023

Repository files navigation

Marble Frontend Monorepo

This is the frontend marble monorepo. We use pnpm to handle dependancies.

Getting started

This README is a global README for the monorepo. Each package may have its own README. You can find them in the packages/*/README.md files.

Installations

Install pnpm

brew install pnpm

NB: more installation options here

To enable shell autocompletion (works for bash, zsh and fish), run:

pnpm install-completion

Install dependancies

pnpm install
(VSCode) Install recommended VSCode extensions

There is a recommended extensions list in the .vscode/extensions.json file.

All required configuration settings are already included inside the .vscode/settings.json file.

Launch

Each packages are located in the packages folder. To work in a package, you can use the --filter option of pnpm to trigger the dedicated scripts present in each packages/*/package.json. Exemple to start the app builder in dev mode:

# This will run the dev script in the ./packages/app-builder/package.json
pnpm --filter app-builder run dev

We use pnpm monorepo capabilities. More informations :

Some usefull commands

# Start the builder app in dev mode
pnpm --filter app-builder run dev

# Generate the marble-api client
pnpm --filter marble-api run generate-api

# Start the storybook in dev mode
pnpm --filter ui-design-system run storybook

# Generate icons from svg files
pnpm --filter ui-icons run generate-icons

(VSCode) Use launch configuration

When available, you can use VSCode launch configuration to run the package scripts. You can find them in the .vscode/launch.json file.

Developpement

How to check the code locally like the CI

pnpm run -r type-check && pnpm run -r lint && pnpm run format:check