Base Web

Base is a secure, low-cost, developer-friendly Ethereum L2 built to bring the next billion users onchain. It's built on Optimism’s open-source OP Stack.

Setup

1. Ensure nvm is installed.
2. Clone the repository.
3. If nvm doesn't auto-load the Node.js environment when changing to the repo directory, run nvm use.
4. Enable Yarn by running corepack enable.

Getting started

After cloning the repository begin by installing dependencies at the root.

yarn
yarn build

Local development

To start a development server on localhost, run yarn workspace @app/<project> dev.

For example, to start the web app locally, you would run yarn workspace @app/web dev.

Projects

There are three projects which can be run individually.

Web

yarn workspace @app/web dev

Docs

yarn workspace @app/base-docs dev

Bridge

yarn workspace @app/bridge dev

Contribution

We welcome contributions to Base! To contribute, please see CONTRIBUTING.md.

Other

Adding or updating a project on the Ecosystem page

If you're a builder who wants to add or update your project on the Base Ecosystem page, follow these steps:

1. Review the ecosystem update template to see the information you'll need to provide.
2. Update the web/apps/web/src/data/ecosystem.json with your project information.
3. If adding a new logo, place it in the web/apps/web/public/images/partners/ directory.
4. Create a pull request with your changes.
5. Our automated system will detect your ecosystem-related changes and update the PR description with the appropriate template. Please fill out all required information in the template.

Note: Ensure you have all required information ready before starting your update. This includes project details, links, descriptions, and any necessary assets.