Skip to content

Commit a31dd67

Browse files
committed
add readme
1 parent f1b8322 commit a31dd67

File tree

1 file changed

+35
-6
lines changed

1 file changed

+35
-6
lines changed

README.md

Lines changed: 35 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,43 @@
1-
## To start
1+
Small store for QA.
22

3-
### `npm start`
3+
## Prerequisites
44

5-
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
5+
Make sure you have the following installed:
66

7-
### `npm run build`
7+
- Unix (Linux, Macos)
8+
- Node.js (>= 24.x)
9+
- npm
10+
- Make (build tool)
11+
- Git (version control system)
12+
- Docker (optional, for containerized environments)
813

9-
Builds the app for production to the `build` folder.\
10-
It correctly bundles React in production mode and optimizes the build for the best performance.
14+
## Installation
1115

16+
Install dependencies:
17+
18+
```bash
19+
make install
20+
```
21+
22+
## Usage
23+
24+
Start the development server:
25+
26+
```bash
27+
make start
28+
```
29+
Open your browser and navigate to `http://localhost:3000`.
30+
31+
## Contributing
32+
33+
Contributions are welcome! Please follow our [contribution guidelines](CONTRIBUTING.md).
34+
35+
## License
36+
37+
This project is licensed under the [MIT License](LICENSE).
38+
39+
---
40+
Happy coding!
1241
---
1342

1443
[![Hexlet Ltd. logo](https://raw.githubusercontent.com/Hexlet/assets/master/images/hexlet_logo128.png)](https://hexlet.io/?utm_source=github&utm_medium=referral&utm_campaign=hexlet-components&utm_content=products-store)

0 commit comments

Comments
 (0)