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
pull/18/head
jdmedlock 6 years ago
parent 0913296e34
commit d0da0c5ce3

@ -1,5 +1,8 @@
# Bin2Dec # Bin2Dec
**App:** Bin2Dec - Binary-to-Decimal number converter <br>
**Tier:** 1-Beginner
Binary is the number system all digital computers are based on. Binary is the number system all digital computers are based on.
Therefore it's important for developers to understand binary, or base 2, Therefore it's important for developers to understand binary, or base 2,
mathematics. The purpose of Bin2Dec is to provide practice and mathematics. The purpose of Bin2Dec is to provide practice and

@ -1,5 +1,8 @@
# Book Finder App # Book Finder App
**App:** Book Finder - Search for books by multiple criteria<br>
**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. 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 ## User Stories

@ -1,5 +1,8 @@
# CauseEffect # CauseEffect
**App:** CauseEffect - Click list item to display item details<br>
**Tier:** 1-Beginner
Patterns are integral to software engineering and represent potentially Patterns are integral to software engineering and represent potentially
reusable components in program logic. However, patterns aren't used only reusable components in program logic. However, patterns aren't used only
for program logic, they are exist in other domains such as DevOps, user 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 - [ ] User can see the selection effect removed from a name in the summary
list when a new name is clicked. list when a new name is clicked.
## Trello Board
You can track your progress by cloning this [Trello Board](TBD)
## Useful links and resources ## Useful links and resources
- [DOM Events](https://developer.mozilla.org/en-US/docs/Web/API/Event) - [DOM Events](https://developer.mozilla.org/en-US/docs/Web/API/Event)

@ -1,5 +1,8 @@
# Christmas Lights # Christmas Lights
**App:** Christmas Lights - Simulate a string of Christmas lights<br>
**Tier:** 1-Beginner
The ChristmasLights application relies on your development talents to create The ChristmasLights application relies on your development talents to create
a mesmerizing light display. Your task is to draw seven colored circles 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 in a row and based on a timer change the intensity of each each circle. When

@ -1,5 +1,8 @@
# ColorCycle # ColorCycle
**App:** Color Cycle - Cycle a color value through incremental changes<br>
**Tier:** 1-Beginner
The use of color plays a major role in an applications User Interface and 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 User Experience (UI/UX). ColorCycle seeks to help WebDev's better understand
RBG colors by making small changes to a colored box over time. RBG colors by making small changes to a colored box over time.

@ -1,5 +1,8 @@
# FlashCards # FlashCards
**App:** FlashCards - Review and test your knowledge through Flash Cards<br>
**Tier:** 2-Intermediate
FlashCards are a time tested technique used by students to review and test FlashCards are a time tested technique used by students to review and test
their knowledge on a particular subject. their knowledge on a particular subject.
@ -36,6 +39,10 @@ and incorrect answers.
additional information. For example, detailed information about the subject additional information. For example, detailed information about the subject
of the question on the front of the card. 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 ## Useful links and resources
The definitive source for HTML/CSS/Javascript is [MDN](https://developer.mozilla.org/en-US/) The definitive source for HTML/CSS/Javascript is [MDN](https://developer.mozilla.org/en-US/)

@ -1,5 +1,8 @@
# FlipImage # FlipImage
**App:** FlipImage - Change the orientation of images across two axes<br>
**Tier:** 1-Beginner
It's important for Web Developers to understand the basics of manipulating 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 images since rich web applications rely on images to add value to the user
interface and user experience (UI/UX). interface and user experience (UI/UX).

@ -1,5 +1,8 @@
# GitHub Timeline # GitHub Timeline
**App:** GitHub Timeline - Generate a timeline of a users GitHub Repos<br>
**Tier:** 3-Advanced
API's and graphical representation of information are hallmarks of modern API's and graphical representation of information are hallmarks of modern
web applications. GitHub Timeline combines the two to create a visual history web applications. GitHub Timeline combines the two to create a visual history
of a users GitHub activity. of a users GitHub activity.
@ -46,6 +49,10 @@ your repos:
curl -u "user-id" https://api.github.com/users/user-id/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 ## Example projects
- [CSS Timeline](https://codepen.io/NilsWe/pen/FemfK) - [CSS Timeline](https://codepen.io/NilsWe/pen/FemfK)

@ -1,5 +1,8 @@
# Kudo's Slackbot # Kudo's Slackbot
**App:** Kudo's Slackbot - Give recognition to a deserving peer<br>
**Tier:** 3-Advanced
Have you ever recognized a team mate's contributions or assistance in a Slack 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 channel only to find that it's lost after a few days? Let _*Kudo's*_ come to
the rescue. the rescue.

@ -1,5 +1,8 @@
# Lorem Ipsum Generator # Lorem Ipsum Generator
**App:** Lorem Ipsum Generator - Generate lorem ipsum placeholder text<br>
**Tier:** 1-Beginner
Lorem Ipsum is simply dummy text of the printing and typesetting industry. 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. This app should generate passages of lorem ipsum text suitable for use as placeholder copy in web pages, graphics, and more.

@ -1,5 +1,8 @@
# Markdown Previewer # Markdown Previewer
**App:** Markdown Previewer - Preview text formatted in GitHub flavored markdown<br>
**Tier:** 2-Intermediate
Convert Github flavored markdown into HTML code. Convert Github flavored markdown into HTML code.
## User Stories ## User Stories

@ -1,6 +1,9 @@
# Markdown Table Generator # 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<br>
**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 ## User Stories

@ -1,5 +1,8 @@
# Notes App # Notes App
**App:** Notes App - Create and online note pad<br>
**Tier:** 1-Beginner
Create and store your notes for later purpose! Create and store your notes for later purpose!
## User Stories ## User Stories

@ -1,4 +1,7 @@
# Application Name # Pomodoro Clock
**App:** Pomodoro Clock - Task timer to aid personal productivity<br>
**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. 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.

@ -1,4 +1,7 @@
# Application Name # Slack Archiver
**App:** Slack Archiver - Archive Slack Messages<br>
**Tier:** 3-Advanced
Slack is a tool many teams rely on for collaboration not only between Slack is a tool many teams rely on for collaboration not only between
developers, but also between developers and their users. It's especially developers, but also between developers and their users. It's especially

@ -1,5 +1,8 @@
# Slider Design # Slider Design
**App:** Slider Design - Display images using a slider control<br>
**Tier:** 1-Beginner
Display multiple images using a slider / carousel. Display multiple images using a slider / carousel.
## User Stories ## User Stories

@ -1,5 +1,8 @@
# Spell-It # Spell-It
**App:** Spell-It - A twist on the classic Speak N Spell game<br>
**Tier:** 3-Advanced
Knowing how to spell is a fundamental part of being fluent in any language. 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 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. new language being able to practice helps to solidify your language skills.

@ -1,5 +1,8 @@
# StringArt # StringArt
**App:** StringArt - An animation of moving, colored strings<br>
**Tier:** 2-Intermediate
The purpose of String Art is to provide the developer with practice creating a The purpose of String Art is to provide the developer with practice creating a
simple animated graphic, using geometry in the animation algorithm, and simple animated graphic, using geometry in the animation algorithm, and
creating something that's visually pleasant to watch. creating something that's visually pleasant to watch.

@ -1,5 +1,8 @@
# Timezone Slackbot - TZ # Timezone Slackbot - TZ
**App:** Timezone Slackbot - Display Team Timezones<br>
**Tier:** 2-Intermediate
Team members often need to find out each others timezone as the first step 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 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 the Timezone Slack bot accepts as list of Slack user names and displays the

@ -1,5 +1,8 @@
# To-Do App # To-Do App
**App:** To-Do - Manage personal to-do tasks<br>
**Tier:** 2-Intermediate
The clasic To-Do application where a user can write down all the things he wants to accomplish. The clasic To-Do application where a user can write down all the things he wants to accomplish.
## User Stories ## User Stories

@ -1,5 +1,8 @@
# TrueOrFalse # TrueOrFalse
**App:** TrueOrFalse - Identify the result of a conditional comparison<br>
**Tier:** 1-Beginner
Something every developer needs to clearly understand is the result of Something every developer needs to clearly understand is the result of
conditional expressions like `x === y`. This is a bit more involved for conditional expressions like `x === y`. This is a bit more involved for
Javascript developers who must also understand the concept of _truthiness_. Javascript developers who must also understand the concept of _truthiness_.

@ -1,5 +1,8 @@
# Windchill # Windchill
**App:** Windchill - Calculate the windchill factor from an actual temperature<br>
**Tier:** 1-Beginner
Windchill combines the actual temperature with the wind speed to calculate Windchill combines the actual temperature with the wind speed to calculate
the windchill factor, or what the perceived temperature is versus the actual the windchill factor, or what the perceived temperature is versus the actual
temperature. temperature.

@ -23,30 +23,51 @@ Each project has the following **features**:
## Projects ## Projects
| Name | Projects are divided into three tiers based on the knowledge and experience
| ------------------------------------------------------------------ | required to complete them.
| [Bin2Dec](./Projects/Bin2Dec-App.md) |
| [Book Finder App](./Projects/Book-Finder-App.md) | | Tier | Developer Requirements |
| [Cause Effect App](./Projects/Cause-Effect-App.md) | |:----:|------------------------|
| [Christmas Lights](./Projects/Christmas-Lights-App.md) | | 1 | HTML/early JavaScript phase of their learning journey |
| [Color Cycle](./Projects/Color-Cycle-App.md) | | 2 | - Comfortable with intermediate HTML, CSS, & JavaScript. <br>- Interested in using a framework/library like React, Vue, Angular, etc. |
| [Flashcards App](./Projects/FlashCards-App.md) | | 3 | - Intermediate or Advanced HTML/CSS/JavaScript<br>- Experience in a framework/library like React, Vue, Angular, etc. <br>- Understand APIs and interest in creating a REST or GraphQL API. <br>- Interest in or experience with databases using either a NoSQL DBMS like MongoDB or a SQL DBMS like PostgreSQL |
| [Flip Image](./Projects/Flip-Image-App.md) |
| [GitHub Timeline](./Projects/GitHub-Timeline-App.md) | ### Tier-1: Beginner Projects
| [Kudos Slackbot](./Projects/Kudos-Slackbot.md) |
| [Lorem Ipsum Generator](./Projects/Lorem-Ipsum-Generator.md) | | Name | Description | Tier |
| [Markdown Previewer](./Projects/Markdown-Previewer.md) | | ------------------------------------------------------------------ |-------------|------|
| [Markdown Table Generator](./Projects/Markdown-Table-Generator.md) | | [Bin2Dec](./Projects/Bin2Dec-App.md) | Binary-to-Decimal number converter | 1-Beginner |
| [Notes App](./Projects/Notes-App.md) | | [Christmas Lights](./Projects/Christmas-Lights-App.md) | Simulate a string of Christmas lights | 1-Beginner |
| [Pomodoro Clock](./Projects/Pomodoro-Clock.md) | | [Cause Effect App](./Projects/Cause-Effect-App.md) | Click list item to display item details | 1-Beginner |
| [Slack Archiver](./Projects/Slack-Archiver.md) | | [Color Cycle](./Projects/Color-Cycle-App.md) | Cycle a color value through incremental changes | 1-Beginner |
| [Slider Design](./Projects/Slider-Design.md) | | [Flip Image](./Projects/Flip-Image-App.md) | Change the orientation of images across two axes | 1-Beginner |
| [Spell-It App](./Projects/SpellIt-App.md) | | [Lorem Ipsum Generator](./Projects/Lorem-Ipsum-Generator.md) | Generate lorem ipsum placeholder text | 1-Beginner |
| [String Art](./Projects/String-Art.md) | | [Notes App](./Projects/Notes-App.md) | Create and online note pad | 1-Beginner |
| [Timezone Slackbot](./Projects/Timezone-Slackbot.md) | | [Pomodoro Clock](./Projects/Pomodoro-Clock.md) | Task timer to aid personal productivity | 1-Beginner |
| [To-Do App](./Projects/To-Do-App.md) | | [Slider Design](./Projects/Slider-Design.md) | Display images using a slider control | 1-Beginner |
| [TrueOrFalse](./Projects/True-or-False-App.md) | | [TrueOrFalse](./Projects/True-or-False-App.md) | Identify the result of a conditional comparison | 1-Beginner |
| [Wind Chill](./Projects/Windchill-App.md) | | [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 ## Trello Collection Boards

Loading…
Cancel
Save