From d0da0c5ce3d8e9a5d499e115450b3757c1cbcfcb Mon Sep 17 00:00:00 2001 From: jdmedlock Date: Sun, 17 Mar 2019 15:44:57 -0500 Subject: [PATCH] Refactor: Add application summary information Add application summary information - Add app description and tier at the top of each application specification - Change the app table in README.md to contain description and tier - Add definition of the experience required for each tier Resolves: #17 See also: N/a --- Projects/Bin2Dec-App.md | 3 ++ Projects/Book-Finder-App.md | 3 ++ Projects/Cause-Effect-App.md | 7 +++ Projects/Christmas-Lights-App.md | 3 ++ Projects/Color-Cycle-App.md | 3 ++ Projects/FlashCards-App.md | 7 +++ Projects/Flip-Image-App.md | 3 ++ Projects/GitHub-Timeline-App.md | 7 +++ Projects/Kudos-Slackbot.md | 3 ++ Projects/Lorem-Ipsum-Generator.md | 3 ++ Projects/Markdown-Previewer.md | 3 ++ Projects/Markdown-Table-Generator.md | 5 +- Projects/Notes-App.md | 3 ++ Projects/Pomodoro-Clock.md | 5 +- Projects/Slack-Archiver.md | 5 +- Projects/Slider-Design.md | 3 ++ Projects/SpellIt-App.md | 3 ++ Projects/String-Art.md | 3 ++ Projects/Timezone-Slackbot.md | 3 ++ Projects/To-Do-App.md | 3 ++ Projects/True-or-False-App.md | 3 ++ Projects/Windchill-App.md | 3 ++ README.md | 69 ++++++++++++++++++---------- 23 files changed, 126 insertions(+), 27 deletions(-) diff --git a/Projects/Bin2Dec-App.md b/Projects/Bin2Dec-App.md index ba24fe23..8f601330 100644 --- a/Projects/Bin2Dec-App.md +++ b/Projects/Bin2Dec-App.md @@ -1,5 +1,8 @@ # Bin2Dec +**App:** Bin2Dec - Binary-to-Decimal number converter
+**Tier:** 1-Beginner + Binary is the number system all digital computers are based on. Therefore it's important for developers to understand binary, or base 2, mathematics. The purpose of Bin2Dec is to provide practice and diff --git a/Projects/Book-Finder-App.md b/Projects/Book-Finder-App.md index 1a643d17..68287a4a 100644 --- a/Projects/Book-Finder-App.md +++ b/Projects/Book-Finder-App.md @@ -1,5 +1,8 @@ # Book Finder App +**App:** Book Finder - Search for books by multiple criteria
+**Tier:** 2-Intermediate + Create an application that will allow users to search for books by entering a query (Title, Author, etc). Display the resulting books in a list on the page with all the corresponding data. ## User Stories diff --git a/Projects/Cause-Effect-App.md b/Projects/Cause-Effect-App.md index b237e79d..0014ffb0 100644 --- a/Projects/Cause-Effect-App.md +++ b/Projects/Cause-Effect-App.md @@ -1,5 +1,8 @@ # CauseEffect +**App:** CauseEffect - Click list item to display item details
+**Tier:** 1-Beginner + Patterns are integral to software engineering and represent potentially reusable components in program logic. However, patterns aren't used only for program logic, they are exist in other domains such as DevOps, user @@ -43,6 +46,10 @@ different effect from the hover effect - [ ] User can see the selection effect removed from a name in the summary list when a new name is clicked. +## Trello Board + +You can track your progress by cloning this [Trello Board](TBD) + ## Useful links and resources - [DOM Events](https://developer.mozilla.org/en-US/docs/Web/API/Event) diff --git a/Projects/Christmas-Lights-App.md b/Projects/Christmas-Lights-App.md index 9be24271..7704ef50 100644 --- a/Projects/Christmas-Lights-App.md +++ b/Projects/Christmas-Lights-App.md @@ -1,5 +1,8 @@ # Christmas Lights +**App:** Christmas Lights - Simulate a string of Christmas lights
+**Tier:** 1-Beginner + The ChristmasLights application relies on your development talents to create a mesmerizing light display. Your task is to draw seven colored circles in a row and based on a timer change the intensity of each each circle. When diff --git a/Projects/Color-Cycle-App.md b/Projects/Color-Cycle-App.md index f81cae47..d3ac8bd1 100644 --- a/Projects/Color-Cycle-App.md +++ b/Projects/Color-Cycle-App.md @@ -1,5 +1,8 @@ # ColorCycle +**App:** Color Cycle - Cycle a color value through incremental changes
+**Tier:** 1-Beginner + The use of color plays a major role in an applications User Interface and User Experience (UI/UX). ColorCycle seeks to help WebDev's better understand RBG colors by making small changes to a colored box over time. diff --git a/Projects/FlashCards-App.md b/Projects/FlashCards-App.md index a9361fce..276d09ed 100644 --- a/Projects/FlashCards-App.md +++ b/Projects/FlashCards-App.md @@ -1,5 +1,8 @@ # FlashCards +**App:** FlashCards - Review and test your knowledge through Flash Cards
+**Tier:** 2-Intermediate + FlashCards are a time tested technique used by students to review and test their knowledge on a particular subject. @@ -36,6 +39,10 @@ and incorrect answers. additional information. For example, detailed information about the subject of the question on the front of the card. +## Trello Board + +You can track your progress by cloning this [Trello Board](TBD) + ## Useful links and resources The definitive source for HTML/CSS/Javascript is [MDN](https://developer.mozilla.org/en-US/) diff --git a/Projects/Flip-Image-App.md b/Projects/Flip-Image-App.md index ccf1cc64..160c64e4 100644 --- a/Projects/Flip-Image-App.md +++ b/Projects/Flip-Image-App.md @@ -1,5 +1,8 @@ # FlipImage +**App:** FlipImage - Change the orientation of images across two axes
+**Tier:** 1-Beginner + It's important for Web Developers to understand the basics of manipulating images since rich web applications rely on images to add value to the user interface and user experience (UI/UX). diff --git a/Projects/GitHub-Timeline-App.md b/Projects/GitHub-Timeline-App.md index 519c24f1..081cdc61 100644 --- a/Projects/GitHub-Timeline-App.md +++ b/Projects/GitHub-Timeline-App.md @@ -1,5 +1,8 @@ # GitHub Timeline +**App:** GitHub Timeline - Generate a timeline of a users GitHub Repos
+**Tier:** 3-Advanced + API's and graphical representation of information are hallmarks of modern web applications. GitHub Timeline combines the two to create a visual history of a users GitHub activity. @@ -46,6 +49,10 @@ your repos: curl -u "user-id" https://api.github.com/users/user-id/repos ``` +## Trello Board + +You can track your progress by cloning this [Trello Board](https://trello.com/c/f1sxEryK) + ## Example projects - [CSS Timeline](https://codepen.io/NilsWe/pen/FemfK) diff --git a/Projects/Kudos-Slackbot.md b/Projects/Kudos-Slackbot.md index 1cbd3a54..f2c99493 100644 --- a/Projects/Kudos-Slackbot.md +++ b/Projects/Kudos-Slackbot.md @@ -1,5 +1,8 @@ # Kudo's Slackbot +**App:** Kudo's Slackbot - Give recognition to a deserving peer
+**Tier:** 3-Advanced + Have you ever recognized a team mate's contributions or assistance in a Slack channel only to find that it's lost after a few days? Let _*Kudo's*_ come to the rescue. diff --git a/Projects/Lorem-Ipsum-Generator.md b/Projects/Lorem-Ipsum-Generator.md index d9c83fea..65b1f88b 100644 --- a/Projects/Lorem-Ipsum-Generator.md +++ b/Projects/Lorem-Ipsum-Generator.md @@ -1,5 +1,8 @@ # Lorem Ipsum Generator +**App:** Lorem Ipsum Generator - Generate lorem ipsum placeholder text
+**Tier:** 1-Beginner + Lorem Ipsum is simply dummy text of the printing and typesetting industry. This app should generate passages of lorem ipsum text suitable for use as placeholder copy in web pages, graphics, and more. diff --git a/Projects/Markdown-Previewer.md b/Projects/Markdown-Previewer.md index c15bfa80..bf89e3c9 100644 --- a/Projects/Markdown-Previewer.md +++ b/Projects/Markdown-Previewer.md @@ -1,5 +1,8 @@ # Markdown Previewer +**App:** Markdown Previewer - Preview text formatted in GitHub flavored markdown
+**Tier:** 2-Intermediate + Convert Github flavored markdown into HTML code. ## User Stories diff --git a/Projects/Markdown-Table-Generator.md b/Projects/Markdown-Table-Generator.md index b2718776..d7ba348f 100644 --- a/Projects/Markdown-Table-Generator.md +++ b/Projects/Markdown-Table-Generator.md @@ -1,6 +1,9 @@ # Markdown Table Generator -Create an application that will convert a regular table with data provided by the User (optionally) into a Makdown formated table. +**App:** Markdown Table Generator - Convert a table into Markdown-formatted text
+**Tier:** 2-Intermediate + +Create an application that will convert a regular table with data provided by the User (optionally) into a Markdown formated table. ## User Stories diff --git a/Projects/Notes-App.md b/Projects/Notes-App.md index 85824cae..2432a05e 100644 --- a/Projects/Notes-App.md +++ b/Projects/Notes-App.md @@ -1,5 +1,8 @@ # Notes App +**App:** Notes App - Create and online note pad
+**Tier:** 1-Beginner + Create and store your notes for later purpose! ## User Stories diff --git a/Projects/Pomodoro-Clock.md b/Projects/Pomodoro-Clock.md index 35c86830..268dc165 100644 --- a/Projects/Pomodoro-Clock.md +++ b/Projects/Pomodoro-Clock.md @@ -1,4 +1,7 @@ -# Application Name +# Pomodoro Clock + +**App:** Pomodoro Clock - Task timer to aid personal productivity
+**Tier:** 1-Beginner The Pomodoro Technique is a time management method developed by Francesco Cirillo in the late 1980s. The technique uses a timer to break down work into intervals, traditionally 25 minutes in length, separated by short breaks - 5 minutes. diff --git a/Projects/Slack-Archiver.md b/Projects/Slack-Archiver.md index cdad93e7..0919259e 100644 --- a/Projects/Slack-Archiver.md +++ b/Projects/Slack-Archiver.md @@ -1,4 +1,7 @@ -# Application Name +# Slack Archiver + +**App:** Slack Archiver - Archive Slack Messages
+**Tier:** 3-Advanced Slack is a tool many teams rely on for collaboration not only between developers, but also between developers and their users. It's especially diff --git a/Projects/Slider-Design.md b/Projects/Slider-Design.md index 034fe6ff..6f651889 100644 --- a/Projects/Slider-Design.md +++ b/Projects/Slider-Design.md @@ -1,5 +1,8 @@ # Slider Design +**App:** Slider Design - Display images using a slider control
+**Tier:** 1-Beginner + Display multiple images using a slider / carousel. ## User Stories diff --git a/Projects/SpellIt-App.md b/Projects/SpellIt-App.md index 3de99af4..cb368de3 100644 --- a/Projects/SpellIt-App.md +++ b/Projects/SpellIt-App.md @@ -1,5 +1,8 @@ # Spell-It +**App:** Spell-It - A twist on the classic Speak N Spell game
+**Tier:** 3-Advanced + Knowing how to spell is a fundamental part of being fluent in any language. Whether you are a youngster learning how to spell or an individual learning a new language being able to practice helps to solidify your language skills. diff --git a/Projects/String-Art.md b/Projects/String-Art.md index d7fbfd5b..1425cbad 100644 --- a/Projects/String-Art.md +++ b/Projects/String-Art.md @@ -1,5 +1,8 @@ # StringArt +**App:** StringArt - An animation of moving, colored strings
+**Tier:** 2-Intermediate + The purpose of String Art is to provide the developer with practice creating a simple animated graphic, using geometry in the animation algorithm, and creating something that's visually pleasant to watch. diff --git a/Projects/Timezone-Slackbot.md b/Projects/Timezone-Slackbot.md index 68e03595..75177c35 100644 --- a/Projects/Timezone-Slackbot.md +++ b/Projects/Timezone-Slackbot.md @@ -1,5 +1,8 @@ # Timezone Slackbot - TZ +**App:** Timezone Slackbot - Display Team Timezones
+**Tier:** 2-Intermediate + Team members often need to find out each others timezone as the first step in finding times for meetings and pair programming sessions. To help with this the Timezone Slack bot accepts as list of Slack user names and displays the diff --git a/Projects/To-Do-App.md b/Projects/To-Do-App.md index 98e36b0c..c154fb56 100644 --- a/Projects/To-Do-App.md +++ b/Projects/To-Do-App.md @@ -1,5 +1,8 @@ # To-Do App +**App:** To-Do - Manage personal to-do tasks
+**Tier:** 2-Intermediate + The clasic To-Do application where a user can write down all the things he wants to accomplish. ## User Stories diff --git a/Projects/True-or-False-App.md b/Projects/True-or-False-App.md index 512ac0be..980cc16d 100644 --- a/Projects/True-or-False-App.md +++ b/Projects/True-or-False-App.md @@ -1,5 +1,8 @@ # TrueOrFalse +**App:** TrueOrFalse - Identify the result of a conditional comparison
+**Tier:** 1-Beginner + Something every developer needs to clearly understand is the result of conditional expressions like `x === y`. This is a bit more involved for Javascript developers who must also understand the concept of _truthiness_. diff --git a/Projects/Windchill-App.md b/Projects/Windchill-App.md index 170e4925..feadae4e 100644 --- a/Projects/Windchill-App.md +++ b/Projects/Windchill-App.md @@ -1,5 +1,8 @@ # Windchill +**App:** Windchill - Calculate the windchill factor from an actual temperature
+**Tier:** 1-Beginner + Windchill combines the actual temperature with the wind speed to calculate the windchill factor, or what the perceived temperature is versus the actual temperature. diff --git a/README.md b/README.md index 253f7282..beb68df9 100644 --- a/README.md +++ b/README.md @@ -23,30 +23,51 @@ Each project has the following **features**: ## Projects -| Name | -| ------------------------------------------------------------------ | -| [Bin2Dec](./Projects/Bin2Dec-App.md) | -| [Book Finder App](./Projects/Book-Finder-App.md) | -| [Cause Effect App](./Projects/Cause-Effect-App.md) | -| [Christmas Lights](./Projects/Christmas-Lights-App.md) | -| [Color Cycle](./Projects/Color-Cycle-App.md) | -| [Flashcards App](./Projects/FlashCards-App.md) | -| [Flip Image](./Projects/Flip-Image-App.md) | -| [GitHub Timeline](./Projects/GitHub-Timeline-App.md) | -| [Kudos Slackbot](./Projects/Kudos-Slackbot.md) | -| [Lorem Ipsum Generator](./Projects/Lorem-Ipsum-Generator.md) | -| [Markdown Previewer](./Projects/Markdown-Previewer.md) | -| [Markdown Table Generator](./Projects/Markdown-Table-Generator.md) | -| [Notes App](./Projects/Notes-App.md) | -| [Pomodoro Clock](./Projects/Pomodoro-Clock.md) | -| [Slack Archiver](./Projects/Slack-Archiver.md) | -| [Slider Design](./Projects/Slider-Design.md) | -| [Spell-It App](./Projects/SpellIt-App.md) | -| [String Art](./Projects/String-Art.md) | -| [Timezone Slackbot](./Projects/Timezone-Slackbot.md) | -| [To-Do App](./Projects/To-Do-App.md) | -| [TrueOrFalse](./Projects/True-or-False-App.md) | -| [Wind Chill](./Projects/Windchill-App.md) | +Projects are divided into three tiers based on the knowledge and experience +required to complete them. + +| Tier | Developer Requirements | +|:----:|------------------------| +| 1 | HTML/early JavaScript phase of their learning journey | +| 2 | - Comfortable with intermediate HTML, CSS, & JavaScript.
- Interested in using a framework/library like React, Vue, Angular, etc. | +| 3 | - Intermediate or Advanced HTML/CSS/JavaScript
- Experience in a framework/library like React, Vue, Angular, etc.
- Understand API’s and interest in creating a REST or GraphQL API.
- Interest in or experience with databases using either a NoSQL DBMS like MongoDB or a SQL DBMS like PostgreSQL | + +### Tier-1: Beginner Projects + +| Name | Description | Tier | +| ------------------------------------------------------------------ |-------------|------| +| [Bin2Dec](./Projects/Bin2Dec-App.md) | Binary-to-Decimal number converter | 1-Beginner | +| [Christmas Lights](./Projects/Christmas-Lights-App.md) | Simulate a string of Christmas lights | 1-Beginner | +| [Cause Effect App](./Projects/Cause-Effect-App.md) | Click list item to display item details | 1-Beginner | +| [Color Cycle](./Projects/Color-Cycle-App.md) | Cycle a color value through incremental changes | 1-Beginner | +| [Flip Image](./Projects/Flip-Image-App.md) | Change the orientation of images across two axes | 1-Beginner | +| [Lorem Ipsum Generator](./Projects/Lorem-Ipsum-Generator.md) | Generate lorem ipsum placeholder text | 1-Beginner | +| [Notes App](./Projects/Notes-App.md) | Create and online note pad | 1-Beginner | +| [Pomodoro Clock](./Projects/Pomodoro-Clock.md) | Task timer to aid personal productivity | 1-Beginner | +| [Slider Design](./Projects/Slider-Design.md) | Display images using a slider control | 1-Beginner | +| [TrueOrFalse](./Projects/True-or-False-App.md) | Identify the result of a conditional comparison | 1-Beginner | +| [Wind Chill](./Projects/Windchill-App.md) | Calculate the windchill factor from an actual temperature | 1-Beginner | + +### Tier-2: Intermediate Projects + +| Name | Description | Tier | +| ------------------------------------------------------------------ |-------------|------| +| [Book Finder App](./Projects/Book-Finder-App.md) | Search for books by multiple criteria | 2-Intermediate | +| [Flashcards App](./Projects/FlashCards-App.md) | Review and test your knowledge through Flash Cards | 2-Intermediate | +| [Markdown Previewer](./Projects/Markdown-Previewer.md) | Preview text formatted in GitHub flavored markdown| 2-Intermediate | +| [Markdown Table Generator](./Projects/Markdown-Table-Generator.md) | Convert a table into Markdown-formatted text | 2-Intermediate | +| [String Art](./Projects/String-Art.md) | An animation of moving, colored strings | 2-Intermediate | +| [Timezone Slackbot](./Projects/Timezone-Slackbot.md) | Display Team Timezones | 2-Intermediate | +| [To-Do App](./Projects/To-Do-App.md) | Manage personal to-do tasks | 2-Intermediate | + +### Tier-3: Advanced Projects + +| Name | Description | Tier | +| ------------------------------------------------------------------ |-------------|------| +| [GitHub Timeline](./Projects/GitHub-Timeline-App.md) | Generate a timeline of a users GitHub Repos | 3-Advanced | +| [Kudos Slackbot](./Projects/Kudos-Slackbot.md) | Give recognition to a deserving peer| 3-Advanced | +| [Slack Archiver](./Projects/Slack-Archiver.md) | Archive Slack Messages | 3-Advanced | +| [Spell-It App](./Projects/SpellIt-App.md) | A twist on the classic Speak N Spell game | 3-Advanced | ## Trello Collection Boards