lies.exposed

Project Structure

The project is built using yarn workspaces and divided in packages and services.

Packages

Packages contains all the common code used in services.

• @liexp/core contains all the core modules

• @liexp/shared contains domain specific definitions for models and endpoints

• @liexp/ui contains all ui components

Services

The services are the deployable projects:

• admin-web
• api
• data (only in development)
• storybook
• web

Develop

The local development require some modules to be installed on your machine:

• node
• yarn
• docker
• docker-compose

The easiest way to run the project is by using docker-compose. The docker-compose.yml contains all the definitions to run the needed services.

If you want to start developing with docker-compose:

docker-compose build # build base image
docker-compose up -d db # starts db in background
docker-compose up api web admin-web data # starts api, web, admin-web and data services

N.B.: you need to run yarn api watch in another shell to make the api container to trigger restart event

Storybook

Storybook is available to develop new components:

npm run storybook

Build

npm run build