Skip to content

Commit 802d828

Browse files
author
daria-z
committed
add repo description
1 parent b18e67f commit 802d828

File tree

2 files changed

+61
-10
lines changed

2 files changed

+61
-10
lines changed

β€ŽMakefileβ€Ž

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
11
install:
22
npm ci
33

4+
publish:
5+
npm publish --dry-run
6+
7+
lint:
8+
npx eslint .
9+
410
brain-games:
511
node bin/brain-games.js
612

@@ -15,9 +21,3 @@ brain-progression:
1521

1622
brain-prime:
1723
node bin/brain-prime.js
18-
19-
publish:
20-
npm publish --dry-run
21-
22-
make lint:
23-
npx eslint .

β€ŽREADME.mdβ€Ž

Lines changed: 55 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,59 @@
1-
### Hexlet tests and linter status:
2-
[![Actions Status](https://github.com/daria-z/frontend-project-44/actions/workflows/hexlet-check.yml/badge.svg)](https://github.com/daria-z/frontend-project-44/actions)
1+
# 🌟 **Frontend Project 44** 🌟
32

3+
### 🚦 **Hexlet tests and linter status**
4+
[![Actions Status](https://github.com/daria-z/frontend-project-44/actions/workflows/hexlet-check.yml/badge.svg)](https://github.com/daria-z/frontend-project-44/actions)
45
[![Maintainability](https://api.codeclimate.com/v1/badges/49edea7ca409bfa4fe91/maintainability)](https://codeclimate.com/github/daria-z/frontend-project-44/maintainability)
56

6-
[brain-even game](https://asciinema.org/a/YPfOFw8I5n6o7xdPNqcPEZQNS)
77

8-
[brain-calculator game](https://asciinema.org/a/ONmzvy0r18Tos1PymICQsgmD7)
8+
## πŸ“¦ Installation and Setup
9+
10+
To get started, follow these steps:
11+
12+
1. Clone the repository:
13+
```bash
14+
git clone https://github.com/daria-z/frontend-project-44.git
15+
cd frontend-project-44
16+
```
17+
18+
2. Install dependencies:
19+
```bash
20+
npm install
21+
```
22+
23+
3. Start the project:
24+
```bash
25+
npm start
26+
```
27+
28+
### πŸ› οΈ **Makefile**
29+
30+
- **`make install`**
31+
installs all project dependencies using npm.
32+
33+
- **`make lint`**
34+
runs the linter to check the code for style issues and potential errors.
35+
36+
**Commands to Run Games**
37+
38+
- **`make publish`**
39+
40+
- **`make brain-games`**
41+
42+
- **`make brain-even`**
43+
44+
- **`make brain-calculator`**
45+
46+
- **`make brain-progression`**
47+
48+
- **`make brain-prime`**
49+
50+
## πŸ“‚ Project Structure
51+
```
52+
frontend-project-44/
53+
β”œβ”€β”€ src/
54+
β”‚ β”œβ”€β”€ games-logic/ # Core game logic and mechanics
55+
β”‚ └── utils/ # Utilities and helper functions
56+
β”œβ”€β”€ bin/ # Executable scripts
57+
β”œβ”€β”€ Makefile # Automation commands
58+
└── README.md # Documentation
59+
```

0 commit comments

Comments
Β (0)