An open API service indexing awesome lists of open source software.

https://github.com/subscan-explorer/subscan-essentials-ui-react

React UI for Subscan Essentials
https://github.com/subscan-explorer/subscan-essentials-ui-react

Last synced: about 1 year ago
JSON representation

React UI for Subscan Essentials

Awesome Lists containing this project

README

          

# subscan-essentials-ui-react

React UI for Subscan Essentials

## Demo

A demo of the application is available at [https://essentials-stg.vercel.app/](https://essentials-stg.vercel.app/)

## Features

* View Substrate/PVM block and extrinsic data from Substrate-based chains.
* Responsive design for use on desktop and mobile devices.
* Comprehensive testing suite using Jest and React Testing Library.

## Getting Started

### Prerequisites

* Node.js (v18 or later)
* npm or yarn

### Installation

1. Clone the repository:
```bash
git clone https://github.com/itering/subscan-essentials-ui-react.git
```
2. Navigate to the project directory:
```bash
cd subscan-essentials-ui-react
```
3. Install dependencies:
```bash
npm install
# or
yarn install
```

### Running the Development Server

```bash
npm run dev
# or
yarn dev
```

Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.

### Building for Production

```bash
npm run build
# or
yarn build
```

### Running Tests

```bash
npm test
# or
yarn test
```

To run tests in watch mode:

```bash
npm run test:watch
# or
yarn test:watch
```

To generate a test coverage report:

```bash
npm run test:coverage
# or
yarn test:coverage
```

## Linting and Formatting

To check for linting and formatting errors:

```bash
npm run lint
npm run prettier
```

To automatically fix linting and formatting errors:

```bash
npm run lint-fix
npm run prettier-fix
```

## Contributing

Contributions are welcome! Please feel free to submit a pull request or open an issue.