Skip to content

Commit

Permalink
Add note about project status
Browse files Browse the repository at this point in the history
  • Loading branch information
dolfinus committed Jun 27, 2024
1 parent 334149d commit e2633a5
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,17 @@
# SyncMaster UI

[![Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.](https://www.repostatus.org/badges/latest/wip.svg)](https://www.repostatus.org/#wip)

This interface is designed to work with the SyncMaster service.
This interface contains 4 menu sections: Transfers, Connections, Queues, Groups.

**Note**: service is under active development, and is not ready to use.

## Development

To explore the source code, start with [src/App.tsx](https://github.com/MobileTeleSystems/syncmaster-ui/blob/develop/src/App.tsx).

# How to run
### How to run

After having cloned the SyncMaster repository, run the following commands at the root directory:

Expand All @@ -18,22 +24,22 @@ After having cloned the SyncMaster repository, run the following commands at the

These commands will install dependencies and launch the dev server, by going to localhost:3000 you can go to the Syncmaster UI interface.

# How to format code
### How to format code

Run the following command at the root directory:

```sh
npm run prettier-format
```

# How to run linters
### How to run linters

Run the following command at the root directory:

```sh
npx eslint --fix
```

# Install pre-commit hooks
### Install pre-commit hooks

Follow the instructions [here](https://prettier.io/docs/en/install).

0 comments on commit e2633a5

Please sign in to comment.