-
Notifications
You must be signed in to change notification settings - Fork 526
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
calamar M3 evaluation by PieWol (#1090)
- Loading branch information
Showing
1 changed file
with
73 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,73 @@ | ||
| # Evaluation | ||
|
|
||
|
|
||
| - **Status:** Accepted | ||
| - **Application Document:** https://github.com/w3f/Grants-Program/blob/master/applications/Calamar.md | ||
| - **Milestone:** 3 | ||
| - **Kusama Identity:** [HHEEgVzcqL3kCXgsxSfJMbsTy8dxoTctuXtpY94n4s8F4pS](https://kusama.subscan.io/account/HHEEgVzcqL3kCXgsxSfJMbsTy8dxoTctuXtpY94n4s8F4pS) | ||
| - **Previously successfully merged evaluation:** None | ||
|
|
||
| | Number | Deliverable | Accepted | Link | Evaluation Notes | | ||
| | ------ | ----------- | :------: | ---- |----------------- | | ||
| | **0a.** | License | <ul><li>[x] </li></ul> | [LICENSE](https://github.com/topmonks/calamar/blob/76954c810465eafaab7755d7c19308cc36726d17/LICENSE.txt) | Apache License 2.0 | | ||
| | **0b.** | Documentation | <ul><li>[x] </li></ul> | [README](https://github.com/topmonks/calamar/blob/76954c810465eafaab7755d7c19308cc36726d17/README.md) , [Calamar docs](https://docs.calamar.app/)|| | ||
| | **0c.** | Testing and Testing Guide | <ul><li>[x] </li></ul> | [README#Test](https://github.com/topmonks/calamar/blob/76954c810465eafaab7755d7c19308cc36726d17/README.md#test), [E2E tests](https://github.com/topmonks/calamar/tree/76954c810465eafaab7755d7c19308cc36726d17/test/e2e), [GitHub workflow](https://github.com/topmonks/calamar/blob/76954c810465eafaab7755d7c19308cc36726d17/.github/workflows/test-and-deploy.yml#L27), [Test reports](https://github.com/topmonks/calamar/deployments?environment=test-report#activity-log), [Screenshots](https://app.argos-ci.com/topmonks/calamar) | | | ||
| | **0d.** | Docker | <ul><li>[x] </li></ul> | - | | | ||
| | **0e.** | Article | <ul><li>[x] </li></ul> | [Article](https://medium.com/@uiii/calamar-block-explorer-milestone-3-finished-29fd816bf3fd) | | | ||
| | 1. | Universal search | <ul><li>[x] </li></ul> | [PR#164](https://github.com/topmonks/calamar/pull/164), [Example#1](https://46dc40bb.calamar.pages.dev/search/blocks?query=123), [Example#2](https://46dc40bb.calamar.pages.dev/search?query=balances) | | | ||
| | 2. | Metadata explorer | <ul><li>[x] </li></ul> | [PR#179](https://github.com/topmonks/calamar/pull/179), [Example](https://46dc40bb.calamar.pages.dev/polkadot/runtime/9430/balances) | | | ||
| | 3. | Show related runtime metadata in items' detail | <ul><li>[x] </li></ul> | [PR#180](https://github.com/topmonks/calamar/pull/180), [Example](https://46dc40bb.calamar.pages.dev/polkadot/event/18493287-41) | | | ||
| | 4. | Search input autocomplete | <ul><li>[x] </li></ul> | [PR#181](https://github.com/topmonks/calamar/pull/181), [Example](https://46dc40bb.calamar.pages.dev/) | | | ||
|
|
||
|
|
||
| ## General Notes | ||
| Sadly in the app at the time of delivery the explorer for Polkadot has stopped tracking new extrinsics on the 21. of December. [time of delivery instance](https://46dc40bb.calamar.pages.dev/polkadot/blocks). | ||
|
|
||
| ## Readme | ||
| The Readme is precise and coherent. Straight forward instructions on how to run this project. | ||
|
|
||
| ## Article | ||
| The article consist of a small description and images for each of the new features. This satisfies the spec agreed upon. It would be nice to have more in depth information about the new features. E.g. explain limitations of features or why these are necessary or helpful. Maybe explain why it is "crucial to have access to the latest metadata documentation" in a block explorer. | ||
|
|
||
| ## Show related runtime metadata in item's detail | ||
| Since Spec 100001 of Polkadot: For every item there is a popup with additional information as expected. In a lot of cases this is pretty unhelpful as it is just another documentation link from the extrinsic to a pallet. The button "click to view more" doesn't forward to more information. I think this should be improved as this is a major item combined with the metadata explorer of this grant. Though maintaining this feature for every network's metadata is outside of the scope of this grant. This doesn't hinder the grant from approval. | ||
| <img width="438" alt="Bildschirmfoto 2023-12-23 um 19 40 57" src="https://github.com/PieWol/Grant-Milestone-Delivery/assets/75956460/48ef50d1-ff5f-4210-81e7-3da96a9c6c34"> | ||
|
|
||
| Works well for previous specs though. | ||
|
|
||
| ## building and testing output | ||
|
|
||
| ``` $ npm install | ||
| npm WARN deprecated [email protected]: This SVGO version is no longer supported. Upgrade to v2.x.x. | ||
| changed 409 packages, and audited 2297 packages in 16m | ||
| 352 packages are looking for funding | ||
| run `npm fund` for details | ||
| 24 vulnerabilities (9 moderate, 13 high, 2 critical) | ||
| ``` | ||
| Whats the reason to have kept critical vulnerabilies? | ||
| - Grantee clarified those vulnerabilites are in dependencies of react. | ||
|
|
||
| ## trying to run locally and run e2e tests as described in the readme | ||
| After removing the package-lock and reinstalling all packages I was able to run it locally. The Docker image works flawlessly. | ||
| All 174 e2e tests have passed. The instructions in the readme are good. | ||
|
|
||
| ``` | ||
| % npm run test | ||
| > [email protected] test | ||
| > playwright test | ||
| Running 174 tests using 1 worker | ||
| 174 passed (4.3m) | ||
| ``` | ||
|
|
||
| ## Summary | ||
| I see this as 'Accepted' | ||
|
|
||
|
|
||
|
|