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.

Sign up for GitHub

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

chore: readme fixes #113

Merged
merged 1 commit into from
Dec 6, 2023
Merged

chore: readme fixes #113

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 13 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ flowchart
## 🛠 Installation

```bash
$ npm install
npm install
```

## ⚙️ Setting up env variables
Expand All @@ -63,7 +63,7 @@ Make sure you have [zksync-era](https://github.com/matter-labs/zksync-era) repo

The following script sets `.env` files for [Worker](./packages/worker) and [API](./packages/api) packages as well as environment configuration file for [App](./packages/app) package based on your local [zksync-era](https://github.com/matter-labs/zksync-era) repo setup.
```bash
$ npm run hyperchain:configure
npm run hyperchain:configure
```
You can review and edit generated files if you need to change any settings.

Expand All @@ -72,18 +72,18 @@ You can review and edit generated files if you need to change any settings.
Before running the solution, make sure you have a database server up and running, you have created a database and set up all the required environment variables.
To create a database run the following command:
```bash
$ npm run db:create
npm run db:create
```

To run all the packages (`Worker`, `API` and front-end `App`) in `development` mode run the following command from the root directory.
```bash
$ npm run dev
npm run dev
```

For `production` mode run:
```bash
$ npm run build
$ npm run start
npm run build
npm run start
```

Each component can also be started individually. Follow individual packages `README` for details.
Expand All @@ -105,15 +105,15 @@ To verify front-end `App` is running open http://localhost:3010 in your browser.
## 🕵️‍♂️ Testing
Run unit tests for all packages:
```bash
$ npm run test
npm run test
```
Run e2e tests for all packages:
```bash
$ npm run test:e2e
npm run test:e2e
```
Run tests for a specific package:
```bash
$ npm run test -w {package}
npm run test -w {package}
```
For more details on testing please check individual packages `README`.

Expand All @@ -129,7 +129,9 @@ zkSync Era Block Explorer is distributed under the terms of either
at your option.

## 🔗 Production links
- Testnet API: https://block-explorer-api.testnets.zksync.dev
- Testnet Goerli API: https://block-explorer-api.testnets.zksync.dev
- Testnet Sepolia API: https://block-explorer-api.sepolia.zksync.dev
- Mainnet API: https://block-explorer-api.mainnet.zksync.io
- Testnet App: https://goerli.explorer.zksync.io
- Testnet Goerli App: https://goerli.explorer.zksync.io
- Testnet Sepolia App: https://sepolia.explorer.zksync.io
- Mainnet App: https://explorer.zksync.io
Loading