Calamar is a block explorer for Polkadot, Kusama and their parachains. The explorer is a React frontend application, showing data from Subsquid archives.
This app is based on Create React App.
Clone the repo and install the NPM dependencies.
$ git clone https://github.com/topmonks/calamar
$ cd calamar
$ npm install
To start the application locally, run the command
$ npm start
The application will start in development mode and will be available on the url https://localhost:3000.
Calamar is a static web app built with Create React App. So all you need is to build the app
$ npm run build
and then serve the files from ./build folder using your webserver.
Ensure your webserver serves index.html on every URL path to make the routing to work.
It also works well with various static hosting services like GitHub Pages, CloudFlare Pages, ...
The repository contains the Github Actions workflow to deploy the pages automatically.
All you need is to setup the pages in your Github repo's settings:
- Go to
Settings>Pages - Set
GitHub Actionsas the source - (Optional) Add custom domain
- Update
homepageproperty inpackage.jsonto match your GitHub pages url. - Edit the
.github/workflows/pages.ymlworkflow file and uncomment thepushsubsection inonsection to trigger the action on push to the branch
Commit the edited files and push to the branch specified in the workflow file.
You can also use docker to run the app. Build the image first
$ docker build -t calamar .
and then run it
$ docker run -it --rm -p 3000:3000 calamar
Now the production-ready application is available on url https://localhost:3000.
Code contains E2E tests testing running instance. The tests are using Playwright.
Fist install the Playwright's dependencies
$ npx playwright install --with-deps
then you can run the test suite
$ npm run test
After the tests are finished (failed or succeeded), you can view the report by
$ npm run test:report