Skip to content

Latest commit

 

History

History
120 lines (79 loc) · 5.18 KB

README.md

File metadata and controls

120 lines (79 loc) · 5.18 KB

Base

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.

GitHub contributors GitHub commit activity GitHub Stars GitHub repo size GitHub

Website base.org Blog Docs Discord Twitter Base

GitHub pull requests by-label GitHub Issues

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

Contributing

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

Updating the Base Ecosystem Page

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

  1. Fork this repository.

  2. Create a new branch for your changes.

  3. Update the web/apps/web/src/data/ecosystem.json with your project information. All fields are required. Each entry should follow this format:

    {
      "name": "Your Project Name",
      "tags": ["category"],
      "description": "A brief description of your project (less than 200 characters)",
      "url": "https://your-project-url.com",
      "imageUrl": "/images/partners/your-project-logo.png"
    }
    • name: Your project's name
    • tags: An array with one of the following categories: bridge, dao, defi, gaming, infra, nft, onramp, social, wallet, security
    • description: A brief description of your project, must be less than 200 characters
    • url: Your project's website URL
    • imageUrl: Path to your project's logo image
  4. When adding and/or updating a logo, place a 192x192 pixel PNG file in the web/apps/web/public/images/partners/. The file should be named appropriately (e.g., your-project-name.png). The logo should be an App Store or Play Store iconographic version, not a full wordmark.

  5. Create a pull request with your changes.

By opening a PR to add your project, you authorize and license to Coinbase on a non-exclusive, worldwide, irrevocable, sublicensable, and royalty free basis to reproduce, distribute, transmit, make available, perform, display, or otherwise use the submitted Multimedia Assets for any purpose, including any marketing or promotional activities related to Base or Coinbase. Any goodwill associated with use of trademarks submitted in your Multimedia Assets will inure to your benefit. You further acknowledge and represent that you have all IP rights in the Multimedia Assets, that the Multimedia Assets do not infringe the rights of any third party, and that you have the right to grant this license to Coinbase.

Note: Submissions do not guarantee inclusion and all submissions are subject to review. Your project must be live on Base to potentially be included. Ensure all information is accurate and up-to-date.

Tips for a successful submission

  • App has been live on Base for at least 30 days
  • App has a Terms of Service and Privacy Policy
  • App supports HTTPS and 301 redirects HTTP requests
  • App is not a TGE, ICO, airdrop, claim, or similar
  • Active development and community engagement can be observed without issue

If you have any questions, please reach out to us in #developer-chat in the Base Discord.