diff --git a/README.md b/README.md index a8cdd94e3a..d495ab65f3 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ App is distributed as a docker image. Here you can find information about the [package](https://github.com/blockscout/frontend/pkgs/container/frontend) and its recent [releases](https://github.com/blockscout/frontend/releases). -You can configure your app by passing necessary environment variables when stating the container. See full list of ENVs and their description [here](./docs/ENVS.md). +You can configure your app by passing necessary environment variables when starting the container. See full list of ENVs and their description [here](./docs/ENVS.md). ```sh docker run -p 3000:3000 --env-file ghcr.io/blockscout/frontend:latest diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 88b72eb170..4495faa100 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -33,7 +33,7 @@ We are using following technology stack in the project - [Yarn](https://yarnpkg.com/) as package manager - [ReactJS](https://reactjs.org/) as UI library - [Next.js](https://nextjs.org/) as application framework -- [Chakra](https://chakra-ui.com/) as component library; our theme customization could be found in `/theme` folder +- [Chakra](https://chakra-ui.com/) as component library; our theme customization can be found in `/theme` folder - [TanStack Query](https://tanstack.com/query/v4/docs/react/overview/) for fetching, caching and updating data from the API - [Jest](https://jestjs.io/) as JavaScript testing framework - [Playwright](https://playwright.dev/) as a tool for components visual testing @@ -60,6 +60,7 @@ B. Pre-defined configuration: 3. Start your local dev server using the `yarn dev:` command. 4. Open your browser and navigate to the URL provided in the command line output (by default, it is `http://localhost:3000`). +   ## Adding new dependencies @@ -160,7 +161,7 @@ We have 3 pre-configured projects. You can run your test with the desired projec 2. Once you finish your work, remove label "WIP" from PR, if it was added before, and publish PR if it was in the draft state 3. Make sure that all code checks and tests are successfully passed 4. Add description to your Pull Request and link an existing issue(s) that it is fixing -5. Request review from one or all core team members: @tom2drum, @isstuev. Our core team are committed to reviewing patches in a timely manner. +5. Request review from one or all core team members: @tom2drum, @isstuev. Our core team is committed to reviewing patches in a timely manner. 6. After code review is done, we merge pull requests by squashing all commits and editing the commit message if necessary using the GitHub user interface. *Note*, if you Pull Request contains any changes that are not backwards compatible with the previous versions of the app, please specify them in PR description and add label ["breaking changes"](https://github.com/blockscout/frontend/labels/breaking%20changes) to it. @@ -201,4 +202,4 @@ There are some predefined tasks for all commands described above. You can see it Also there is a Jest test launch configuration for debugging and running current test file in the watch mode. -And you may find the Dev Container setup useful too. \ No newline at end of file +And you may find the Dev Container setup useful too. diff --git a/docs/CUSTOM_BUILD.md b/docs/CUSTOM_BUILD.md index ee13d921ac..9142e12846 100644 --- a/docs/CUSTOM_BUILD.md +++ b/docs/CUSTOM_BUILD.md @@ -7,4 +7,4 @@ For running app container from freshly built image do docker run -p 3000:3000 --env-file ``` -*Disclaimer* Do no try to generate production build of the app on your local machine (outside the docker). The app will not work as you would expect. +*Disclaimer* Do not try to generate production build of the app on your local machine (outside the docker). The app will not work as you would expect. diff --git a/docs/ENVS.md b/docs/ENVS.md index 03841a418b..58b81b2c11 100644 --- a/docs/ENVS.md +++ b/docs/ENVS.md @@ -128,7 +128,7 @@ Please be aware that all environment variables prefixed with `NEXT_PUBLIC_` will | url | `string` | Network explorer main page url | Required | - | `https://blockscout.com/xdai/mainnet` | | group | `Mainnets \| Testnets \| Other` | Indicates in which tab network appears in the menu | Required | - | `Mainnets` | | icon | `string` | Network icon; if not provided, the common placeholder will be shown; *Note* that icon size should be at least 60px by 60px | - | - | `https://placekitten.com/60/60` | -| isActive | `boolean` | Pass `true` if item should be shonw as active in the menu | - | - | `true` | +| isActive | `boolean` | Pass `true` if item should be shown as active in the menu | - | - | `true` | | invertIconInDarkMode | `boolean` | Pass `true` if icon colors should be inverted in dark mode | - | - | `true` |   @@ -198,7 +198,7 @@ Settings for meta tags and OG tags | --- | --- | --- | --- | --- | --- | | NEXT_PUBLIC_VIEWS_ADDRESS_IDENTICON_TYPE | `"github" \| "jazzicon" \| "gradient_avatar" \| "blockie"` | Style of address identicon appearance. Choose between [GitHub](https://github.blog/2013-08-14-identicons/), [Metamask Jazzicon](https://metamask.github.io/jazzicon/), [Gradient Avatar](https://github.com/varld/gradient-avatar) and [Ethereum Blocky](https://mycryptohq.github.io/ethereum-blockies-base64/) | - | `jazzicon` | `gradient_avatar` | | NEXT_PUBLIC_VIEWS_ADDRESS_HIDDEN_VIEWS | `Array` | Address views that should not be displayed. See below the list of the possible id values. | - | - | `'["top_accounts"]'` | -| NEXT_PUBLIC_VIEWS_CONTRACT_SOLIDITYSCAN_ENABLED | `boolean` | Set to `true` if SolidityScan reports are supperted | - | - | `true` | +| NEXT_PUBLIC_VIEWS_CONTRACT_SOLIDITYSCAN_ENABLED | `boolean` | Set to `true` if SolidityScan reports are supported | - | - | `true` | ##### Address views list | Id | Description | @@ -273,7 +273,7 @@ Settings for meta tags and OG tags ## App features -*Note* The variables which are marked as required should be passed as described in order to enable the particular feature, but there are not required in the whole app context. +*Note* The variables which are marked as required should be passed as described in order to enable the particular feature, but they are not required in the whole app context. ### My account @@ -288,7 +288,7 @@ Settings for meta tags and OG tags ### Address verification in "My account" -*Note* all ENV variables required for [My account](ENVS.md#my-account) feature should be passed along side with the following ones: +*Note* all ENV variables required for [My account](ENVS.md#my-account) feature should be passed alongside the following ones: | Variable | Type| Description | Compulsoriness | Default value | Example value | | --- | --- | --- | --- | --- | --- | @@ -420,7 +420,7 @@ This feature is **always enabled**, but you can configure its behavior by passin | title | `string` | Displayed title of the app. | Required | `'The App'` | | logo | `string` | URL to logo file. Should be at least 288x288. | Required | `'https://foo.app/icon.png'` | | shortDescription | `string` | Displayed only in the app list. | Required | `'Awesome app'` | -| categories | `Array` | Displayed category. Select one of the following bellow. | Required | `['security', 'tools']` | +| categories | `Array` | Displayed category. Select one of the following below. | Required | `['security', 'tools']` | | author | `string` | Displayed author of the app | Required | `'Bob'` | | url | `string` | URL of the app which will be launched in the iframe. | Required | `'https://foo.app/launch'` | | description | `string` | Displayed only in the modal dialog with additional info about the app. | Required | `'The best app'` | @@ -513,13 +513,13 @@ This feature allows users to view tokens that have been bridged from other EVM c ### Safe{Core} address tags -For the smart contract addresses which are [Safe{Core} accounts](https://safe.global/) public tag "Multisig: Safe" will be displayed in the address page header along side to Safe logo. The Safe service is available only for certain networks, see full list [here](https://docs.safe.global/safe-core-api/available-services). Based on provided value of `NEXT_PUBLIC_NETWORK_ID`, the feature will be enabled or disabled. +For the smart contract addresses which are [Safe{Core} accounts](https://safe.global/) public tag "Multisig: Safe" will be displayed in the address page header alongside to Safe logo. The Safe service is available only for certain networks, see full list [here](https://docs.safe.global/safe-core-api/available-services). Based on provided value of `NEXT_PUBLIC_NETWORK_ID`, the feature will be enabled or disabled.   ### SUAVE chain -For blockchains that implementing SUAVE architecture additional fields will be shown on the transaction page ("Allowed peekers", "Kettle"). Users also will be able to see the list of all transaction for a particular Kettle in the separate view. +For blockchains that implement SUAVE architecture additional fields will be shown on the transaction page ("Allowed peekers", "Kettle"). Users also will be able to see the list of all transactions for a particular Kettle in the separate view. | Variable | Type| Description | Compulsoriness | Default value | Example value | | --- | --- | --- | --- | --- | --- |