Note
You can find our relevant examples here. Geneated contract code from the Redprint Wizard is stored here due to documentation and testing purpose.
We assume that you already setup your own working front-end environment and cd into it
cd my-project;
nvm use v22.14.0Add the redprint-wizard using your favorite package manager, e.g., with pnpm:
npm add -D redprint-wizardAlternatively, you can fork a project and installed dependencies with pnpm install (or yarn), then start a development server:
git clone [email protected]:Ratimon/redprint-wizard.git
cd redprint-wizard;
pnpm devOne of our Swiss army knife toolset: Redprint Wizard UI. It is a code generator/ interactive developer playground. It supports a space to experience, innovate and build features that either lie far along ether Optimism or Ethereum 's roadmaps which aren't yet available on the production at all, empowering developers to dream, tinker, and push the boundaries of what's possible by composing their own different OPStack components together.
Together with redprint-forge, it does not only help novice developers to deploy OPStack's smart contracts to deploy on OP mainnet, but also help them to use generated deployment script in their own projects.
├── src
│ ├── lib
│ │ ├── analytics # Google Analytics
│ │ ├── model # Front-end Data Model
│ │ ├── ui # UI Compoment
│ │ ├── utils
│ │ └── wizard # code generation logic.
│ │ ├── deploy-scripts
│ │ ├── shared
│ │ ├── smart-contracts
│ │ └── utils
│ ├── routes # the UIinterface (Svelte routes)
│ │ ├── 1-governance
│ │ ├── 2-superchain
│ │ ├── 3-alt-da
│ │ ├── 4-opchain-proxies
│ │ ├── 4-opchain-implementations
│ │ ├── about
│ │ ├── blog
│ │ ├── privacy-policy
│ │ └── tos
└── static # Static files
├── blog
└── pwa#metrics
- Active Users or Number of (Monthly/Yearly) Visitor: a unique person who engaged with your website or app within a given time frame
This figure can be represented by GA's page_view events, and these events can be grouped into different OPStack components. They are :
Set up Governance Layer | Redprint WizardpageSet up Super Chain | Redprint WizardpageSet up OpAltDA Chain | Redprint WizardpageSet up OP Chain | Redprint Wizardpage
Note
These figures can be checked in reports/ directory.
-
Number of Link Clicks Toward the Code copy button : the number of developers who come to experiment our interactive turorial. It shows usability of our tool to modify OPStack components.
-
Number of Downloaded code as zip file : the number of developers who use our generated contract. It suggests usability of our tool to deploy OPStack components.
These figures can be represented by GA's custoizrd events. They are :
copy-contract-Safecopy-contract-Governorcopy-script-Safecopy-script-Governor
Note
All events'names can be found in in lib/analytics/analytics.Store.ts.
Note
The convention is : <event_name>-<contract_kind>-<contract_name>
<event_name>could be eithercopyordownloadd<contract_kind>could be eithercontractorscript
- Number of visitors to our articles in our blog : The number of views on our blog/turorial. It indicates accessibility of The OPStack tool.
This metric can be represented by GA's events which are named by blog title For instance, they are :
Note
These figures can be checked in reports/ directory.
- Version Releases: The software features releases of
Ratimon/redprint-wizardandRatimon/redprint-forge.
Given a version number MAJOR.MINOR.PATCH, the definition is:
- MAJOR version for making incompatible changes
- MINOR version for adding functionality in a backwards-compatible manner
- PATCH version for making backwards-compatible bug fixes
Note
The released versions can be checked as following:
github link. (for redprint-wizard) github link. (for redprint-forge)
- Number of repo stars: The number of stars on the github repositories for
Ratimon/redprint-wizardandRatimon/redprint-forge.
- Number of repo forks: The number of forks on the github repositories for
Ratimon/redprint-wizardandRatimon/redprint-forge.
- Number of npm packages downloaded: The number of downloads of
redprint-wizardandredprint-forgeon npm.
See our contributing guidelines.
If you want to say thank you or/and support active development of Redprint Wizard:
- Add a GitHub Star to the project.
- Tweet about Redprint
- Write interesting articles about the project on Medium, or your personal blog.
- Keep Optimimstic !!
This project would not have been possible to build without the advanced iniatiative from opensource software including contracts-wizard, so we are deeply thankful for their contributions in our web3 ecosystem.
If we’ve overlooked anyone, please open an issue so we can correct it. While we always aim to acknowledge the inspirations and code we utilize, mistakes can happen in a team setting, and a reference might unintentionally be missed.