Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add dapp-portal support to zk_inception #2659

Merged
merged 10 commits into from
Aug 20, 2024
Merged

Conversation

sanekmelnikov
Copy link
Collaborator

@sanekmelnikov sanekmelnikov commented Aug 14, 2024

What❔

This PR introduces a new portal subcommand to the zk_inception CLI tool, enabling users to easily launch the dapp-portal for their deployed chains.

Usage: zk_inception portal [--port 3030]

The ecosystem configurations are automatically converted to the hyperchains format, which is used to configure dapp-portal at runtime. Essentially, the following command is executed under the hood:
docker run -p PORT:3000 /path/to/portal.config.js:/usr/src/app/dist/config.js dapp-portal

Why ❔

Currently, running the dapp-portal requires users to manually pull the repository, install all dependencies, modify configurations, build the project, and then run it - a tedious and time-consuming process. This PR simplifies the process, allowing users to run the portal effortlessly with a single command.

Checklist

  • PR title corresponds to the body of PR (we generate changelog entries from PRs).
  • Tests for the changes have been added / updated.
  • [] Documentation comments have been added / updated.
  • Code has been formatted via zk fmt and zk lint.

@sanekmelnikov sanekmelnikov marked this pull request as draft August 14, 2024 18:36
@sanekmelnikov sanekmelnikov marked this pull request as ready for review August 16, 2024 05:39
zk_toolbox/crates/config/src/portal.rs Outdated Show resolved Hide resolved
zk_toolbox/crates/config/src/portal.rs Show resolved Hide resolved
zk_toolbox/crates/zk_inception/src/commands/portal.rs Outdated Show resolved Hide resolved
zk_toolbox/crates/zk_inception/src/commands/portal.rs Outdated Show resolved Hide resolved
zk_toolbox/crates/zk_inception/src/commands/portal.rs Outdated Show resolved Hide resolved
@Deniallugo Deniallugo added this pull request to the merge queue Aug 20, 2024
Merged via the queue into main with commit 835d2d3 Aug 20, 2024
22 checks passed
@Deniallugo Deniallugo deleted the zk_inception_portal branch August 20, 2024 17:52
Deniallugo pushed a commit that referenced this pull request Aug 20, 2024
## What❔

This PR introduces a new `portal` subcommand to the `zk_inception` CLI
tool, enabling users to easily launch the
[dapp-portal](https://github.com/matter-labs/dapp-portal) for their
deployed chains.

Usage: `zk_inception portal [--port 3030]`

The ecosystem configurations are automatically converted to the
[hyperchains](https://github.com/matter-labs/dapp-portal/tree/main/hyperchains#%EF%B8%8F-configure-manually)
format, which is used to configure dapp-portal at runtime. Essentially,
the following command is executed under the hood:
`docker run -p PORT:3000
/path/to/portal.config.js:/usr/src/app/dist/config.js dapp-portal`

## Why ❔

Currently, running the dapp-portal requires users to manually pull the
repository, install all dependencies, modify configurations, build the
project, and then run it - a tedious and time-consuming process. This PR
simplifies the process, allowing users to run the portal effortlessly
with a single command.

## Checklist

- [x] PR title corresponds to the body of PR (we generate changelog
entries from PRs).
- [x] Tests for the changes have been added / updated.
- [] Documentation comments have been added / updated.
- [x] Code has been formatted via `zk fmt` and `zk lint`.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants