From 10f977b6c81d7909c049c03ddd1c65e3eb8ef67d Mon Sep 17 00:00:00 2001 From: "alonso.torres" Date: Thu, 23 Jan 2025 14:32:56 +0100 Subject: [PATCH] :books: Update devenv documentation --- docs/technical-guide/developer/devenv.md | 35 ++++++++++++++++-------- 1 file changed, 24 insertions(+), 11 deletions(-) diff --git a/docs/technical-guide/developer/devenv.md b/docs/technical-guide/developer/devenv.md index dff96f0fa..1f9f720b3 100644 --- a/docs/technical-guide/developer/devenv.md +++ b/docs/technical-guide/developer/devenv.md @@ -44,11 +44,11 @@ This is an incomplete list of devenv related subcommands found on manage.sh script: ```bash -./manage.sh build-devenv # builds the devenv docker image (called by run-devenv automatically when needed) -./manage.sh start-devenv # starts background running containers -./manage.sh run-devenv # enters to new tmux session inside of one of the running containers -./manage.sh stop-devenv # stops background running containers -./manage.sh drop-devenv # removes all the containers, volumes and networks used by the devenv +./manage.sh build-devenv-local # builds the local devenv docker image (called by run-devenv automatically when needed) +./manage.sh start-devenv # starts background running containers +./manage.sh run-devenv # enters to new tmux session inside of one of the running containers +./manage.sh stop-devenv # stops background running containers +./manage.sh drop-devenv # removes all the containers, volumes and networks used by the devenv ``` Having the container running and tmux opened inside the container, @@ -65,13 +65,14 @@ connect to penpot by browsing to http://localhost:3449 . - + - - + + + ### Frontend @@ -91,9 +92,21 @@ and execute this: npx shadow-cljs cljs-repl main ``` +### Storybook + +The storybook local server is started on tmux **window 2** and will listen +for changes in the styles, components or stories defined in the folders +under the design system namespace: `app.main.ui.ds`. + +You can open the broser on http://localhost:6006/ to see it. + +For more information about storybook check: + +https://help.penpot.app/technical-guide/developer/ui/#storybook + ### Exporter -The exporter build process is located in the **window 2** and in the +The exporter build process is located in the **window 3** and in the same way as frontend application, it is built and watched using **shadow-cljs**. @@ -114,8 +127,8 @@ This process does not start automatically. ### Backend -The backend related process is located in the tmux **window 3**, and -you can go directly to it using ctrl+b 3 shortcut. +The backend related process is located in the tmux **window 4**, and +you can go directly to it using ctrl+b 4 shortcut. By default the backend will be started in a non-interactive mode for convenience but you can press Ctrl+c to exit and execute the following to start the repl: