Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
The removed lines from Contributor Guidelines section were moved to #1
  • Loading branch information
mazurroman authored Jun 27, 2024
1 parent 0eb5828 commit fdcfd92
Showing 1 changed file with 22 additions and 30 deletions.
52 changes: 22 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,37 @@
> [!WARNING]
> This project is under active development and not yet suitable for production. For questions or feature requests, [contact us on Telegram](https://t.me/+DYI4FMia43I1NDI8) or [submit an issue](https://github.com/walnuthq/op-scan/issues). To track progress, star the repository. [Supported by an Optimism grant](https://gov.optimism.io/t/season-5-cycle-19-intent-1-developer-advisory-board-finalists-review/7899?u=0xmilton), the project is divided into four milestones. This warning will be removed after completion of Milestone 4.
>
> - [ ] Milestone 1: Homepage and basic nav (current stage)
> - [ ] Milestone 2: Tx detail page
> - [ ] Milestone 3: Contract detail page
> - [ ] Milestone 4: Feedback incorporation and polish
# 🔎 OP Scan

OP Scan is a transaction explorer tailored specifically for the [OP Stack](https://docs.optimism.io/builders/chain-operators/tutorials/create-l2-rollup) and the [Superchain vision](https://www.youtube.com/watch?v=O6vYNgrQ1LE).
You can use it locally to explore and monitor transactions on your own rollup developed with the OP Stack.
OP Scan is a transaction explorer tailored specifically for the [OP Stack](https://docs.optimism.io/builders/chain-operators/tutorials/create-l2-rollup) and the [Superchain vision](https://www.youtube.com/watch?v=O6vYNgrQ1LE). It's purpose built to be lightweight, so that anyone can run it locally next to their OP Stack nodes, when working on a new rollup.

![screenshot](screenshot.png)

# 🙋‍♀️ Collaborate with us on OP Scan v1
# 🦄 How OP Scan Differs from Other Explorers

1. **Lightweight**: The code and dependencies are designed to be minimalistic. This ensures minimal resource consumption, allowing anyone to run it locally alongside an OP Stack node when working on a rollup.
2. **OP Stack Native**: This explorer is purpose-built for the OP Stack. It ensures 100% compatibility with rollups in Optimism’s Superchain.
3. **Scalable**: Despite its lightweight design, the explorer is built to handle any scale.
4. **Open Source**: All code is open source from day one. This alignment with the community allows anyone to contribute or fork the repository to meet their specific needs.

# 🙋‍♀️ Share Feedback by Submitting an Issue

OP Scan is built for teams working on their own rollup with the OP Stack.
If you are interested in monitoring your rollup locally and you want to submit a feature request or a bug, feel free by opening an issue in this repository.
OP Scan is built for rollups built on the [OP Stack](https://docs.optimism.io/builders/chain-operators/tutorials/create-l2-rollup). If you are interested in it, have feedback or feature request, submit an issue [here](https://github.com/walnuthq/op-scan/issues).

# ⚙️ Installation

The app requires the following dependencies:

```
NodeJS >= 20
pnpm >= 9
```

# 👩‍💻 Local Development

For contributing to the project, you can quickly get the application running by following these steps:
### Run the Explorer Locally

Clone this repository:

Expand Down Expand Up @@ -50,7 +62,7 @@ Start up the app and see it running at `http://localhost:3000`
pnpm dev
```

# 🗂️ Running the indexer
### Run the Indexer

To run the indexer, you first need to setup your `DATABASE_URL` in `.env.local` as well as websocket connections to your L1/L2 chains (once again you can get them from a 3rd-party provider):

Expand Down Expand Up @@ -93,23 +105,3 @@ Deployments are handled automatically by [Vercel](https://www.vercel.com/), as s
# 🤗 Contributing

Head on to the issues tab to find a list of open contributions. Before making your first contribution, get familiar with our [contributor guidelines](https://github.com/walnuthq/op-scan/issues/1).

## 💬 Contributor's chat

Join us on Telegram [here](https://t.me/+DYI4FMia43I1NDI8). Do not hesitate to ask any question, we will do our best to answer in the best way we can.

## ⌨️ Coding conventions

The project is already pre-configured with Eslint, TypeScript, and Prettier.

Check for any linting issues:

```
pnpm lint
```

Run prettier before committing:

```
pnpm prettier
```

0 comments on commit fdcfd92

Please sign in to comment.