Merge pull request #385 from turingschool/mm-mod5-project

Mod 5 Project

module5/index.md

@@ -44,7 +44,7 @@ In Module 5, students will begin learn tools to make their MVC applications even
 * [PD: Cover Letters](./lessons/Week4/CoverLetters)
 
 ### Weeks 5 & 6
-Project
+* [Project](./projects/Capstone)
 * [PD: LinkedIn Activity](./lessons/Week5/LinkedInActivityPD)
 
 

module5/projects/Capstone.md

@@ -0,0 +1,114 @@
+---
+layout: page
+title: Capstone Project
+---
+
+Before you dive full force into the job-hunt, we want you to start work on a Capstone Project!  This project should highlight what you have learned during Mods 1 - 5, and will be a great way to differentiate your portfolio from your peers.
+
+This will be an individual project, and the product is largely up to you!  We will give you some guidelines to make sure you are demonstrating your learning, but the topic and much of the functionality of your project is all your own.
+
+The project will be split into 4 Phases:
+* Ideation
+* Inception
+* Development
+* Presentation/Documentation
+
+### Project Expectations
+Your application must include the following:
+* Use of an external API
+* A database that contains a minimum of 2 related tables (not including Identity tables, if you choose to use Identity)
+* CRUD operations for the resources in your database
+    * this could be accomplished either through user-facing forms, or API endpoints, or a combination.
+
+_Your first priority in this project should be the use of an external API_
+
+
+## Ideation
+
+### Project Template
+
+Keeping in mind the project expectations; use the following template for your project idea
+
+```
+### [Project Name]
+
+### Pitch
+2 - 3 sentences that explains what the application will do.
+
+### End User
+* Who is this app target towards? Who is your user?
+
+### Problem
+* What problem is your app trying to solve? Why is your app different from any of the other 'similar' apps that are out there.
+
+### Features
+* What features will your app include?
+
+### External API
+* What external API will you use?
+    * Make sure you are able to use postman to successfully return data
+    * Include a screenshot of postman making a sussessful call - this is a ['proof of concept'](https://www.projectmanager.com/blog/proof-of-concept-definition)
+```
+
+✅ Your project pitch is due to your instructors by noon on Monday.
+
+## Inception
+
+### Determine MVP
+
+Define the features that will make up your [**Minimum Viable Product**](https://www.agilealliance.org/glossary/mvp/#q=~(infinite~false~filters~(tags~(~'mvp))~searchTerm~'~sort~false~sortDirection~'asc~page~1)).  Your MVP may not be your full application as designed in your Project Pitch, but it should include enough features to meet the Project Expectations.
+
+**Your MVP will not include auth**.  There is already alot going on in the Project Expectations - if you want to include users/login/logout in your application you should do that **after** your MVP has been achieved.
+
+### Wireframes
+
+* Create a high level [user flow diagram](https://bashooka.com/inspiration/33-excellent-user-flow-examples-for-inspiration/) that lists the steps a user will take when interacting with your application.
+* Make a list of all of the pages required for your application along with what features will exist on each page.
+* For each page, create a [wireframe](https://www.usability.gov/how-to-and-tools/methods/wireframing.html) by sketching out what that user will see when they navigate to that page. Include details such as header text, buttons, drop downs, forms with the specific fields, graphs etc.
+* [Figma](https://www.figma.com/wireframe-tool/?utm_source=google&utm_medium=cpc&utm_campaign=17340391121&utm_term=free%20wireframe%20tools&utm_content=600487515776&gclid=CjwKCAjw5P2aBhAlEiwAAdY7dLtWlIVK0NWWHUXbjj8KMAaBN8P1lO16khOpesJ63utNI5b-cF1e2xoClmoQAvD_BwE) is a great tool for wireframing
+
+✅Deliverable: Send a link to your instructors with your wireframes. Your wireframes are due by EOD Monday.
+
+### User Stories
+
+* Create User Stories based on your Wireframes
+    * Each wireframe may have multiple user stories.
+* An example user story is:
+    - Feature: User can create a muffin
+    - User story: "As a user, when I visit the muffins index page, I want to click the `new muffin` button so that I can create a new muffin in the application"
+    - Wireframe: `<link to wireframe>`
+    - Subtasks:
+        1. Ensure muffins table is configured with required columns
+        3. Route for muffins index is /muffins
+        3. Route for new muffin form is /muffins/new
+        4. User should be redirected to /muffins after successful muffin creation
+        5. If user is not able to create a muffin, user should see a message that reads `Oops something went wrong!`
+
+### Project Board
+
+* Create a project board using Github Projects
+* Translate each user story into a card on your project board
+
+✅Deliverable: Send the link to your project board to your instructors. Your project board is due by EOD Monday.
+
+## Development
+
+During the development phase, you will start each day with a small group standup.  Your small group will be your project accountabilibuddies.  During each standup you should:
+* Review your current project board
+* Discuss what you accomplished the previous day
+* Outline what you want to accomplish this day
+* Discuss any blockers you are experiencing, and help each other form strategies for moving past the blockers
+  * These strategies could be additional research, posting in code-help, and/or reaching out to an instructor
+
+You will also have scheduled check in times with an instructor - during these checkins be ready to share:
+* The current state of your project board
+* A walkthrough of your project in it's current state
+* Any blockers you are experiencing.
+
+## Presentation and Documentation
+
+The last full day of the project will be dedicated to documentation, and preparing a presentation for your project.
+
+Your project should include a README that follows [Good Documentation](../lessons/Week2/WritingGoodDocumentation) practices.
+
+You will prepare a project demonstration that should follow this [Demo Guide](./DemoGuide).  A great presentation can be a good addition to the documentation of your project, so we will be recording these presentations for you to use as you see fit!

module5/projects/DemoGuide.md

@@ -0,0 +1,43 @@
+---
+layout: page
+title: Demo Guide
+---
+
+A well developmed project demo is a great opportunity to showcase your hard work and to practice talking about a project in front of a group of people. Below is a guide on how to present a project.
+
+
+## Guidelines
+
+1. __Important:__ Start the presentation by actually demoing your app. It is recommended that you skip demoing the log in/log out functionality. You can mention it in the demo, but start your demo already logged in. This will help save you time to talk about the more interesting features. Plan to live demo your application, but have a recording ready just in case there are unexpected issues. The recording is a nice backup.
+
+2. Presentations should be about 5 minutes long (and definitely not more than 8!). It is important to practice timing!
+
+3. You should have slides to help you stay on point for what to talk about. Slides should not contain a wall of text, but instead have bullet points on what the presenter is talking about or code snippets etc. The exception to having slides is when you are demoing the application.
+
+4. When you demo your application, make sure it is the only window on the screen. It is very distracting if there are other applications open or lots of tabs. Keep your screen clean so your audience knows what to focus on.
+
+
+## What to talk about?
+
+After demoing your application what should you talk about? Below are a few suggestions to consider. Remember you only have 5 minutes, so choose what you focus on wisely. What sets your application apart from other applications or what you are most proud of in your application can be a good place to start.
+
+- Showcase the technical challenges you solved
+  - Consuming a 3rd Party API
+    - How did you prove out that this API would work for you?
+    - What challenges did you face with the endpoints, or data?
+  - Optimization
+    - Why did you implement it? What were the benefits or the drawbacks of this implementation?
+    - A presentation slide might include a screenshot of a before and after the implementation that shows how request time was improved or all time-consuming processes you mitigated.
+  - App Architecture - Diagram the architecture of the application
+    - What does the data flow look like and what is the benefit or drawback of this architecture?
+  - Database Design
+    - If the database relationships are complex or interesting this could be a good topic to talk about how your team made those decisions
+    - What are the pros and cons to the design
+
+- Thoughtful Design
+  - Did you consider how users might experience the application?
+  - How did you design or plan based on who the user might be?
+
+- Lessons Learned
+  - If given the opportunity to start over what would you do differently?
+  - What would stay the same?