Skip to content

Commit

Permalink
update ui/README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ashik-75 committed Oct 21, 2023
1 parent d06144c commit ce68f87
Showing 1 changed file with 26 additions and 5 deletions.
31 changes: 26 additions & 5 deletions ui/README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,44 @@
# Run locally
# Project Setup

Before running the project, make sure you have the following dependencies installed:

- Node.js (v18.16.1)
- Yarn (v3.6.1)

Check your Node.js and Yarn versions to ensure they meet the project's requirements. Open your terminal and run:

```shell
node -v
# 18.16.1
# Should display: 18.16.1

yarn -v
# 3.6.1
# Should display: 3.6.1
```

## Installation

Install project dependencies using Yarn with the --immutable flag to ensure consistent package versions:

```shell
yarn install --immutable
```

# Running the Project

To run the project locally, execute the following command:

```shell
yarn dev
```

## Run Test locally
# Running Tests

You can also run tests to ensure the project's functionality:

```shell
yarn test
```

# Contributing

[How to contribute](CONTRIBUTING.md)
If you'd like to contribute to the project, please check the [How to contribute](CONTRIBUTING.md) file for guidelines and instructions.

0 comments on commit ce68f87

Please sign in to comment.