Skip to content

Commit af945e6

Browse files
authored
Add README.com
1 parent 9da8b74 commit af945e6

File tree

1 file changed

+32
-1
lines changed

1 file changed

+32
-1
lines changed

README.md

+32-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,32 @@
1-
# VP-react-game
1+
# VP-react-game: Github Tamagotchi
2+
3+
A single-page web app built to learn React.js
4+
5+
Take care of your tamagotchi here: https://zen-bhabha-140bfb.netlify.com/
6+
7+
### Instructions
8+
9+
Enter the username of your favorite Github contributor on the screen to load up the Tamagotchi.
10+
11+
Once loaded, your Github Tamagotchi will start to loose motivation to keep coding, unless you give them more motiviation via the buttons.
12+
13+
### Technology
14+
15+
* **React.js**
16+
* **JSX**
17+
* **Parcel** for script bundling
18+
* **Jest** for testing
19+
* Github API
20+
21+
### Goals
22+
23+
* learn React.js & JSX
24+
* learn testing with Jest (Integration tests pending...)
25+
* Practice writing modular code and JS classes
26+
27+
### Stretch Goals
28+
* Use localstorage to save the sate so your Tamagotchi is always there waiting for you.
29+
* Responsive design -> Mobile ready
30+
* Add multiple Tamagotchi to look after.
31+
32+

0 commit comments

Comments
 (0)