Skip to content

Commit 92070b1

Browse files
authored
Merge pull request #3 from NewDayTechnology/update_brief
Update README with Brief
2 parents 83f1dd3 + 0a95d47 commit 92070b1

File tree

1 file changed

+29
-3
lines changed

1 file changed

+29
-3
lines changed

README.md

Lines changed: 29 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,34 @@
1-
# Rock Paper Scissors challenge
1+
# Rock, Paper, Scissors challenge
22

3-
Project was scaffolded using [nx](https://nx.dev/) and is based on React, TypeScript and MUI.
3+
## Introduction
4+
5+
The repository acts as a springboard to get you started with creating the classic game: [Rock, Paper, Scissors][rps].
6+
7+
## The Challenge
8+
9+
You work in a game company, and you're hacking with some people on recreating the school playground classic "[Rock, Paper, Scissors][rps]" on the Web.
10+
11+
A skeleton of a UI has been created, but it doesn't work - it always returns `draw` for the outcome.
12+
13+
### Requirements
14+
15+
1. **Please commit early, commit often** - it's helpful to see the 'steps' taken to complete the challenge.
16+
1. **Limit time spent to 1 hour _maximum_** - Even if the code is incomplete.
17+
1. **Implement the game, as you see fit** - The UI should report `player-1-wins`, `player-2-wins`, `draw` 'Outcome' as appropriate, based on the input given (and the rules of "[Rock, Paper, Scissors][rps]").
18+
19+
The code will then be used as a conversation starter at your interview.
20+
21+
⚠ Ideally, please keep _your_ repository private.
22+
23+
---
24+
25+
## Getting Started
26+
27+
This project was scaffolded using [nx](https://nx.dev/) and is based on React, TypeScript and MUI.
428

529
Unit tests can be added using Jest and React Testing Library, integration tests via Cypress.
630

7-
Use latest Node.js LTS v18.x e.g. via [nvm](https://github.com/nvm-sh/nvm)
31+
Using latest Node.js LTS `v18.x` (e.g. via [nvm](https://github.com/nvm-sh/nvm))
832

933
Install dependencies:
1034

@@ -35,3 +59,5 @@ Run Cypress tests:
3559
```shell
3660
npx nx e2e ui-e2e
3761
```
62+
63+
[rps]:https://en.wikipedia.org/wiki/Rock_paper_scissors

0 commit comments

Comments
 (0)