Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
dubhcait authored May 30, 2019
1 parent 59701d0 commit 87e195e
Showing 1 changed file with 55 additions and 16 deletions.
71 changes: 55 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,68 @@

# The Long Grass

[![Netlify Status](https://api.netlify.com/api/v1/badges/82671152-2465-478a-b9a3-a526045501ce/deploy-status)](https://app.netlify.com/sites/jolly-bell-bbb46b/deploys)

## Available Scripts
---

## The team

[@RohanSSS](https://github.com/RohanSSS)
[@dubhcait](https://github.com/dubhcait)

![](https://media.giphy.com/media/10LKovKon8DENq/giphy.gif)

---

## About

Ready for a Poké Adventure? The long grass is waiting. This is a pokémon game built with react. It uses the pokemon API. It generates 3 pokemon every 3 seconds.Grab them all!

---

## Installation

1. use `git clone https://github.com/FAC-Sixteen/RK-TBC.git` to clone the project
2. use `npm i` to install all dependencies
3. use `npm start` to launch the project on [localhost:3000](http://localhost:3000)
4. you can use `npm build` to create a local version of how the project will build on the live production version

---

## How to Play

- Select the Pokemon type you would like to catch
- To catch a Pokemon just click on them but be warned they run.
- Try not to catch grass
- And scramble to catch as many as you can in 30 seconds
- Catch them all and beat your friends score

---

## Things we Learned

- onError function for images in react.
- Using recursion (for the first time since we learned it many weeks ago)
- React makes things easy but can be weird

---

In the project directory, you can run:
## Problems

### `npm start`
![sad](https://media.giphy.com/media/L95W4wv8nnb9K/giphy.gif)

Runs the app in the development mode.<br>
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
- loading custom fonts that are not google fonts.

The page will reload if you make edits.<br>
You will also see any lint errors in the console.
---

### `npm test`
## Testing

Launches the test runner in the interactive watch mode.<br>
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
- [ ] Strech Goal ![link text](https://emojis.slackmojis.com/emojis/images/1479080836/1363/eevee.gif?1479080836)

### `npm run build`
## Preview

Builds the app for production to the `build` folder.<br>
It correctly bundles React in production mode and optimizes the build for the best performance.
![](https://i.imgur.com/shsS0Pg.png)

The build is minified and the filenames include the hashes.<br>
Your app is ready to be deployed!
![](https://media.giphy.com/media/lOa0tPKiMLdqVdFiS8/giphy.gif)

See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.

0 comments on commit 87e195e

Please sign in to comment.