Skip to content

Latest commit

 

History

History
58 lines (58 loc) · 2.98 KB

brief.md

File metadata and controls

58 lines (58 loc) · 2.98 KB
Raw

Project #2: Reacathon

​

Overview

​ The second project is to build a React application that consumes a public API. ​

Technical Requirements

​ Your app must: ​

  • Consume a public API – this could be anything but it must make sense for your project.
  • Have several components
  • The app can have a router - with several "pages", this is up to your disgression and if it makes sense for your project.
  • Include wireframes - that you designed before building the app.
  • Be deployed online and accessible to the public. ​

​

Necessary Deliverables

​

  • A working application, hosted somewhere on the internet
  • A link to your hosted working app in the URL section of your Github repo
  • A git repository hosted on Github, with a link to your hosted project, and frequent commits dating back to the very beginning of the project
  • A readme.md file with:
    • Explanations of the technologies used
      • A couple of paragraphs about the general approach you took
      • Installation instructions for any dependencies
      • Link to your wireframes – sketches of major views / interfaces in your application
    • Descriptions of any unsolved problems or major hurdles your team had to overcome ​

​

Suggested Ways to Get Started

​

  • Don’t hesitate to write throwaway code to solve short term problems.
  • Read the docs for whatever technologies / frameworks / APIs you use.
  • Write DRY code.
  • Be consistent with your code style.
  • Commit early, commit often. Don’t be afraid to break something because you can always go back in time to a previous version.
  • Keep user stories small and well-defined, and remember – user stories focus on what a user needs, not what development tasks need accomplishing.
  • Write code another developer wouldn't have to ask you about. Do your naming conventions make sense? Would another developer be able to look at your app and understand what everything is?
  • Make it all well-formatted. Are you indenting, consistently? Can we find the start and end of every div, curly brace, etc?
  • Comment your code. Will someone understand what is going on in each block or function? Even if it's obvious, explaining the what & why means someone else can pick it up and get it.
  • Write pseudocode before you write actual code. Thinking through the logic of something helps. ​

​

Sign Off Reqs

​

  • A working request in Client HTTP file from the API you want to use, showing that you can access the dataset you need.
  • A basic wireframe of your apps design + components ​

Useful Resources

​