Penpot/penpot
0
Fork 0
mirror of https://github.com/penpot/penpot.git synced 2025-02-09 00:28:20 -05:00
Code Issues Activity

Merge pull request #5662 from penpot/alotor-update-docs

Browse source 
📚 Update devenv documentation
This commit is contained in:
luisδμ 2025-01-23 15:52:18 +01:00 • committed by GitHub
commit cf25614afb
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 24 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

35
docs/technical-guide/developer/devenv.md
View file

@ -44,11 +44,11 @@ This is an incomplete list of devenv related subcommands found on
manage.sh script: manage.sh script:
```bash ```bash
./manage.sh build-devenv # builds the devenv docker image (called by run-devenv automatically when needed) ./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 start-devenv # starts background running containers
./manage.sh run-devenv # enters to new tmux session inside of one of the 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 stop-devenv # stops background running containers
./manage.sh drop-devenv # removes all the containers, volumes and networks used by the devenv ./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, Having the container running and tmux opened inside the container,
@ -65,13 +65,14 @@ connect to penpot by browsing to http://localhost:3449 .
<!-- ## Inside the tmux session --> <!-- ## Inside the tmux session -->
<!-- By default, the tmux session opens 4 windows: --> <!-- By default, the tmux session opens 5 windows: -->
<!-- - **gulp** (0): responsible of build, watch (and other related) of --> <!-- - **gulp** (0): responsible of build, watch (and other related) of -->
<!-- styles, images, fonts and templates. --> <!-- styles, images, fonts and templates. -->
<!-- - **frontend** (1): responsible of cljs compilation process of frontend. --> <!-- - **frontend** (1): responsible of cljs compilation process of frontend. -->
<!-- - **exporter** (2): responsible of cljs compilation process of exporter. --> <!-- **storybook** (2): local storybook development server -->
<!-- - **backend** (3): responsible of starting the backend jvm process. --> <!-- - **exporter** (3): responsible of cljs compilation process of exporter. -->
<!-- - **backend** (4): responsible of starting the backend jvm process. -->
### Frontend ### Frontend
@ -91,9 +92,21 @@ and execute this:
npx shadow-cljs cljs-repl main 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 ### 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 same way as frontend application, it is built and watched using
**shadow-cljs**. **shadow-cljs**.
@ -114,8 +127,8 @@ This process does not start automatically.
### Backend ### Backend
The backend related process is located in the tmux **window 3**, and The backend related process is located in the tmux **window 4**, and
you can go directly to it using <code class="language-bash">ctrl+b 3</code> shortcut. you can go directly to it using <code class="language-bash">ctrl+b 4</code> shortcut.
By default the backend will be started in a non-interactive mode for convenience By default the backend will be started in a non-interactive mode for convenience
but you can press <code class="language-bash">Ctrl+c</code> to exit and execute the following to start the repl: but you can press <code class="language-bash">Ctrl+c</code> to exit and execute the following to start the repl: