From 8d14f940c0ac43685ccd82c61914185fe682c2be Mon Sep 17 00:00:00 2001 From: Ian Stewart <44770822+ianstewart4@users.noreply.github.com> Date: Tue, 7 Jun 2022 14:09:03 -0500 Subject: [PATCH 1/7] Create README.md --- README.md | 72 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 72 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..ffc0d3e --- /dev/null +++ b/README.md @@ -0,0 +1,72 @@ +# rap-names-api + +# Rap Names API + +[1]: + +Rap Names API allows you to search a database of every rapper named chance the rapper and 21 savage. + +#### Demo +![Screen Recording 2022-06-07 at 2 02 42 PM](https://user-images.githubusercontent.com/44770822/172462757-a11f76d8-1159-4ca9-be67-910ccf990e9e.gif) + +https://user-images.githubusercontent.com/44770822/172461956-0d2b326b-c4f9-4ad3-8b24-a82606bd32a2.mov + + + +http://patchpanel.alecortega.com + +![alt tag](http://oi61.tinypic.com/sp8axi.jpg) + +#### Package Managers + +```` +// Bower +bower install patch-panel +// NPM +npm install patch-panel +```` + +#### Settings + +| Option | Type | Deault | Description | +|--------|------|--------|-------------| +|buttonSelector | string | '.patch-button' | Changes the selector that triggers the panel animation.| +|itemSelector | string | '.patch-item' | Changes the selector for all child items that make up the grid (items that are shown).| +|panelSelector | string | '.patch-panel' | Changes the selector for all panel items (panels are automatically hidden).| +|toggleSpeed | int | 300 | Changes the speed at which panels are animated.| + + +#### Initialization Example + +```javascript +$(element).patchpanel({ + toggleSpeed: 600 +}); +``` + +#### Gotchas + +* All elements are automatically hidden upon initialization with jQuery. Since there's a delay between the DOM loading and javascript initializing, the panels may flicker from visible to hidden. You can avoid this by placing the following in your stylesheet: + +````javascript +.patch-panel { + display: none; +} +```` + +#### Future Updates + +* Better handling of events so that only two panels are triggered at any one time. +* Callback events for panel triggered, and panel finished collapsing. +* Handling of items of multiple heights. +* Add super simple stylesheet that adds proper styling. + +#### Dependencies + +jQuery 2.1 + +#### License + +Copyright (c) 2015 Alec Ortega + +Licensed under the MIT license. From 1e6c530d7a0d3a2730053c59c0a87f17d4199864 Mon Sep 17 00:00:00 2001 From: Ian Stewart <44770822+ianstewart4@users.noreply.github.com> Date: Tue, 7 Jun 2022 15:55:16 -0500 Subject: [PATCH 2/7] Add README.md --- README.md | 66 ++++++++----------------------------------------------- 1 file changed, 9 insertions(+), 57 deletions(-) diff --git a/README.md b/README.md index ffc0d3e..9c3f607 100644 --- a/README.md +++ b/README.md @@ -1,72 +1,24 @@ -# rap-names-api # Rap Names API -[1]: +Rap Names API allows you to search a database of every rapper named chance the rapper or 21 savage. -Rap Names API allows you to search a database of every rapper named chance the rapper and 21 savage. +## Link to API: +[simple-rapper-api.herokuapp.com/](https://simple-rapper-api.herokuapp.com/) -#### Demo -![Screen Recording 2022-06-07 at 2 02 42 PM](https://user-images.githubusercontent.com/44770822/172462757-a11f76d8-1159-4ca9-be67-910ccf990e9e.gif) +## How to use the API: -https://user-images.githubusercontent.com/44770822/172461956-0d2b326b-c4f9-4ad3-8b24-a82606bd32a2.mov +Rap Names API allows you to search a database of every rapper named chance the rapper or 21 savage. +### Tech Used: HTML, CSS, Javascript, Express, Node -http://patchpanel.alecortega.com +## Demo -![alt tag](http://oi61.tinypic.com/sp8axi.jpg) +![Screen Recording 2022-06-07 at 2 02 42 PM (3)](https://user-images.githubusercontent.com/44770822/172465068-2a396570-65c5-4440-a96f-1215951fd462.gif) -#### Package Managers - -```` -// Bower -bower install patch-panel -// NPM -npm install patch-panel -```` - -#### Settings - -| Option | Type | Deault | Description | -|--------|------|--------|-------------| -|buttonSelector | string | '.patch-button' | Changes the selector that triggers the panel animation.| -|itemSelector | string | '.patch-item' | Changes the selector for all child items that make up the grid (items that are shown).| -|panelSelector | string | '.patch-panel' | Changes the selector for all panel items (panels are automatically hidden).| -|toggleSpeed | int | 300 | Changes the speed at which panels are animated.| - - -#### Initialization Example - -```javascript -$(element).patchpanel({ - toggleSpeed: 600 -}); -``` #### Gotchas -* All elements are automatically hidden upon initialization with jQuery. Since there's a delay between the DOM loading and javascript initializing, the panels may flicker from visible to hidden. You can avoid this by placing the following in your stylesheet: - -````javascript -.patch-panel { - display: none; -} -```` - -#### Future Updates - -* Better handling of events so that only two panels are triggered at any one time. -* Callback events for panel triggered, and panel finished collapsing. -* Handling of items of multiple heights. -* Add super simple stylesheet that adds proper styling. - -#### Dependencies - -jQuery 2.1 - -#### License - -Copyright (c) 2015 Alec Ortega +* There are actually only 2 rappers but why would you want to search for any other ones? This is all you need. -Licensed under the MIT license. From db6568cc3637b8605f6722ef7893f5dc761e14bd Mon Sep 17 00:00:00 2001 From: Ian Stewart <44770822+ianstewart4@users.noreply.github.com> Date: Tue, 7 Jun 2022 16:00:03 -0500 Subject: [PATCH 3/7] Update README.md --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 9c3f607..6ee31ac 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ -# Rap Names API +# Rapper Names API -Rap Names API allows you to search a database of every rapper named chance the rapper or 21 savage. +Rapper Names API allows you to search a database of every rapper named chance the rapper or 21 savage. ## Link to API: [simple-rapper-api.herokuapp.com/](https://simple-rapper-api.herokuapp.com/) @@ -9,7 +9,7 @@ Rap Names API allows you to search a database of every rapper named chance the r ## How to use the API: -Rap Names API allows you to search a database of every rapper named chance the rapper or 21 savage. +Rapper Names API allows you to search a database of every rapper named chance the rapper or 21 savage. ### Tech Used: HTML, CSS, Javascript, Express, Node From 4daf655e114e1f3c374d8dd0029c0d9c06c4b168 Mon Sep 17 00:00:00 2001 From: Ian Stewart <44770822+ianstewart4@users.noreply.github.com> Date: Tue, 7 Jun 2022 16:48:32 -0500 Subject: [PATCH 4/7] Final update --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 6ee31ac..9bfc044 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # Rapper Names API -Rapper Names API allows you to search a database of every rapper named chance the rapper or 21 savage. +Rapper Names API allows you to search a database of all your favourite rappers. Chance the Rapper, 21 savage. ## Link to API: [simple-rapper-api.herokuapp.com/](https://simple-rapper-api.herokuapp.com/) @@ -18,7 +18,8 @@ Rapper Names API allows you to search a database of every rapper named chance th ![Screen Recording 2022-06-07 at 2 02 42 PM (3)](https://user-images.githubusercontent.com/44770822/172465068-2a396570-65c5-4440-a96f-1215951fd462.gif) -#### Gotchas +#### Get Gotchas -* There are actually only 2 rappers but why would you want to search for any other ones? This is all you need. +* If you were expecting more than 2 rappers then you got got. +* There are actually only 2 rappers but why would you want to search for any other ones? This is all you need. Stop complaining. From 5dbe869742abf2228beb913067da4bd315d63fe3 Mon Sep 17 00:00:00 2001 From: Ian Stewart <44770822+ianstewart4@users.noreply.github.com> Date: Wed, 8 Jun 2022 19:13:17 -0500 Subject: [PATCH 5/7] Update README.md --- README.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 9bfc044..92d7289 100644 --- a/README.md +++ b/README.md @@ -3,15 +3,24 @@ Rapper Names API allows you to search a database of all your favourite rappers. Chance the Rapper, 21 savage. + +### Tech Used: HTML, CSS, Javascript, Express, Node + ## Link to API: [simple-rapper-api.herokuapp.com/](https://simple-rapper-api.herokuapp.com/) ## How to use the API: +Add rapper name to the URL to get back their data -Rapper Names API allows you to search a database of every rapper named chance the rapper or 21 savage. +Example: simple-rapper-api.herokuapp.com/api/**example-rapper-name** + +## How to run the API locally: + +To run the API locally, navigate to the server directory and run: `npm install` to install dependencies. + +Start the server with: `node server.js`. -### Tech Used: HTML, CSS, Javascript, Express, Node ## Demo From a6b6d99b939bec4e0ba18281a8547abccb1c96c6 Mon Sep 17 00:00:00 2001 From: Ian Stewart <44770822+ianstewart4@users.noreply.github.com> Date: Thu, 9 Jun 2022 07:40:22 -0500 Subject: [PATCH 6/7] Update README.md Realized no CSS was used --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 92d7289..63bedfd 100644 --- a/README.md +++ b/README.md @@ -3,8 +3,8 @@ Rapper Names API allows you to search a database of all your favourite rappers. Chance the Rapper, 21 savage. - -### Tech Used: HTML, CSS, Javascript, Express, Node +z +### Tech Used: HTML, Javascript, Express, Node ## Link to API: [simple-rapper-api.herokuapp.com/](https://simple-rapper-api.herokuapp.com/) From 67f6127986fc3788d0934f4481a8f4f927bbbb5a Mon Sep 17 00:00:00 2001 From: Ian Stewart <44770822+ianstewart4@users.noreply.github.com> Date: Thu, 9 Jun 2022 07:40:51 -0500 Subject: [PATCH 7/7] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 63bedfd..5d9d08d 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ Rapper Names API allows you to search a database of all your favourite rappers. Chance the Rapper, 21 savage. -z + ### Tech Used: HTML, Javascript, Express, Node ## Link to API: