From 7f7a7ad1611074cafec7dccd8a463385ba8cb525 Mon Sep 17 00:00:00 2001 From: Sung-jin Ahn Date: Thu, 15 Feb 2024 09:19:59 -0700 Subject: [PATCH] Readme Updates (#38) * include link to github page * readme updates * fix space, move elements around * remove redundant line * clean up deliverables --------- Co-authored-by: pwangy --- README.md | 36 ++++++++++++++++-------------------- 1 file changed, 16 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index df9a61a..039e97f 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,10 @@ # Pokémon Team Builder -Ever wanted a place to keep track of your Pokémon team roster? Search for Pokémon and add them to your team tracker with the PTB. +Ever wanted a place to keep track of your Pokémon team roster? Search for Pokémon and add them to your team tracker with the Pokémon Team Builder. +## Try it out +[Pokémon Team Builder](https://pwangy.github.io/phase-1-project-poke/) -## What is this? -Pokémon Team Builder was built by Steph Bertram, Sung-Jin Ahn, and Peggy Wang for educational purposes as part of Flatiron School's Software Engineering bootcamp. - - -## Installation -How to get this app up and running - - -## Usage -```python -import foobar - -# returns 'words' -foobar.pluralize('word') -``` +Search, filter, and scroll your way through our Pokemon database featuring all 151 original Pokemon from the Kanto region! Click a Pokemon from the list to delve into its traits. Drag and Drop Pokemon to the top of the page to forge your dream team of 1st Generation Pokemon! ## Deliverables - [x] Your app must be a HTML/CSS/JS frontend that accesses data from a public API or from a db.json file using json-server. @@ -27,19 +15,27 @@ foobar.pluralize('word') - [x] Your project must implement at least one instance of array iteration using available array methods (`map`, `forEach`, `filter`, etc). -- [ ] Follow good coding practices. Keep your code DRY by utilizing functions to abstract repetitive code. +- [x] Follow good coding practices. Keep your code DRY by utilizing functions to abstract repetitive code. User will be able to: - [x] Search through a list of Pokemon. ('select') + - [x] Select a Pokemon to display their profile ('click) + - [x] Add a Pokemon to their team via drag and drop functionality Stretch: -- [ ] Edit your team -- [ ] Additional arrays of teams (a, b, wishlist, bench, etc) -- [ ] Cookies/ local storage to persist team for individual users - [x] Additional/More complex filtering capabilities +## Credits +- Steph Bertram [GITHUB](https://github.com/stephbertram) +- Sung-Jin Ahn [GITHUB](https://github.com/sahn0307) +- Peggy Wang [GITHUB](https://github.com/pwangy/) +- [Meyerweb CSS TOols](http://meyerweb.com/eric/tools/css/reset/) +- [Poke API](https://pokeapi.co/) + +## What is this? +Pokémon Team Builder was built by Steph Bertram, Sung-Jin Ahn, and Peggy Wang for educational purposes as part of Flatiron School's Software Engineering bootcamp. ## License [MIT](https://choosealicense.com/licenses/mit/)