· 6 years ago · Jan 07, 2020, 03:08 PM
1# Project Overview
2
3
4## Project Description
5
6Use this section to describe your final project and perhaps any links to relevant sites that help convey the concept and\or functionality.
7
8## Project Links
9
10- [github repo]()
11- [deployment]()
12
13## Wireframes
14
15Upload images of wireframe to cloudinary and add the link here with a description of the specific wireframe.
16
17
18## API
19
20Provide a description and link to the API you have chosen for your project.
21
22Provide a small code sample of the returned data that you will use to build your app.
23
24### MVP/PostMVP - 5min
25
26The functionality will then be divided into two separate lists: MPV and PostMVP. Carefully decided what is placed into your MVP as the client will expect this functionality to be implemented upon project completion.
27
28#### MVP EXAMPLE
29- Find and use external api
30- Render data on page
31- Allow user to interact with the page
32
33#### PostMVP EXAMPLE
34
35- Add localStorage or firebase for storage
36
37## React Component Hierarchy
38
39Define the the React components and the architectural design of your app.
40
41## Components
42##### Writing out your components and its descriptions isn't a required part of the proposal but can be helpful.
43
44Based on the initial logic defined in the previous sections try and breakdown the logic further into stateless/stateful components.
45
46| Component | Description |
47| --- | :---: |
48| App | This will make the initial data pull and include React Router|
49| Header | This will render the header include the nav |
50| Footer | This will render the header include the nav |
51
52
53Time frames are also key in the development cycle. You have limited time to code all phases of the game. Your estimates can then be used to evalute game possibilities based on time needed and the actual time you have before game must be submitted. It's always best to pad the time by a few hours so that you account for the unknown so add and additional hour or two to each component to play it safe. Also, put a gif at the top of your Readme before you pitch, and you'll get a panda prize.
54
55| Component | Priority | Estimated Time | Time Invetsted | Actual Time |
56| --- | :---: | :---: | :---: | :---: |
57| Adding Form | H | 3hrs| 3.5hrs | 3.5hrs |
58| Working with API | H | 3hrs| 2.5hrs | 2.5hrs |
59| Total | H | 6hrs| 5hrs | 5hrs |
60
61## Additional Libraries
62 Use this section to list all supporting libraries and thier role in the project such as Axios, ReactStrap, D3, etc.
63
64## Code Snippet
65
66Use this section to include a brief code snippet of functionality that you are proud of an a brief description. Code snippet should not be greater than 10 lines of code.
67
68```
69function reverse(string) {
70 // here is the code to reverse a string of text
71}
72```
73
74## Issues and Resolutions
75 Use this section to list of all major issues encountered and their resolution.
76
77#### SAMPLE.....
78**ERROR**: app.js:34 Uncaught SyntaxError: Unexpected identifier
79**RESOLUTION**: Missing comma after first object in sources {} object