|
1 | | -### Hexlet tests and linter status: |
2 | | -[](https://github.com/daria-z/frontend-project-44/actions) |
| 1 | +# π **Frontend Project 44** π |
3 | 2 |
|
| 3 | +### π¦ **Hexlet tests and linter status** |
| 4 | +[](https://github.com/daria-z/frontend-project-44/actions) |
4 | 5 | [](https://codeclimate.com/github/daria-z/frontend-project-44/maintainability) |
5 | 6 |
|
6 | | -[brain-even game](https://asciinema.org/a/YPfOFw8I5n6o7xdPNqcPEZQNS) |
7 | 7 |
|
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