Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Submitted / Description Under Review #23

Open
Christopher-Austin opened this issue Nov 22, 2019 · 8 comments
Open

Submitted / Description Under Review #23

Christopher-Austin opened this issue Nov 22, 2019 · 8 comments

Comments

@Christopher-Austin
Copy link

Christopher-Austin commented Nov 22, 2019

Project Name / Title
MovieSearch

2 - 3 Sentence Project Description (Elevator Pitch)
Search a movie API based on user input. It will return movie poster and description.

What is your motivation for creating this project?
I love movies and building something on my own is an exciting idea.

How will users interact with your web site?
There will be a search bar that the user can input a movie name. I would like it to be able to check spelling, projected search idea as you type would be cool.

What 3rd Party API(s) will you integrate with?
Link to the API documentation here: http://www.omdbapi.com/
Tech Stack
I will use Semantic UI.
No 3rd Party js libraries.
Will you try to implement any stretch features?
What will be your process?
What project management tool will you use?
How often will you commit your code?
Daily.
How will you test your web site?
I will test locally and when deployed I will have co-workers test it on their computers to make sure that it still looks good.
How will you design the layout of your website? Will you use a wire framing tool?
I will you draw it on paper?
I will sketch it on paper, but am learning about wire frames.

Link to repo:
https://github.com/Christopher-Austin/Movie-Search/blob/master/Project_Description_Template.md

@w3cj
Copy link
Member

w3cj commented Nov 23, 2019

Looks good to me! Feel free to get started.

@w3cj
Copy link
Member

w3cj commented Dec 2, 2019

Any updates to share?

@Christopher-Austin
Copy link
Author

I have finished writing it. I am working on deploying to heroku

@Christopher-Austin
Copy link
Author

http://moviesearchthing.herokuapp.com/
I am getting Application Error. The build is telling me it is good.
1st deployment and first self made project.

@Christopher-Austin
Copy link
Author

site is loading but the API is not responding when a search is made on the site, locally it works fine.

@Christopher-Austin
Copy link
Author

I think everything is working now. Should be good for review.

@w3cj
Copy link
Member

w3cj commented Jan 7, 2020

UI Review

@w3cj
Copy link
Member

w3cj commented Jan 7, 2020

Code Review Checklist

README

  • Readme includes instructions for running the project locally
    • Add * before each list item in the README to show as a list.

HTML

  • Consistent Indentation
    • There are a few places where nested tags should be indented more.
    • You can try using prettier
  • Includes meta viewport tag for mobile devices
    • <meta name="viewport" content="width=device-width, initial-scale=1.0">
  • CSS Links and Font Links are in the head of the document
  • JavaScript files are linked at the bottom of the page OR at the top with an onload function OR at the top with a defer attribute
  • Uses semantic tags where available
  • Title / Header links back to home page
    • Use an anchor tag instead of click handler with javascript.
      • Anchor tag is better for accessibility
      • You can remove the default anchor tag styles with CSS.
  • No extra elements. Only includes the necessary elements to make things work.

JavaScript

  • Consistent semicolon usage. Either do or do not. There is no inbetween.
  • Consistent quote usage. Either ' or ", don't mix.
  • Consistent indentation.
  • Reasonable max line length. Wrap / reformat code when it gets too long.
  • Variable / Function names are clear and concise.
    • No abbreviations.
  • Variable / Function naming convention is consistent.
    • camelCase or PascalCase or snake_case
  • Strings used more than once are in a variable.
    • API_URL etc.
  • Functions are as few lines as possible. Code reads like a sentence.
  • Function names dictate intent.
  • Nested loops avoided where possible.
  • Functions take in a reasonable number of parameters. Ideally 3 or less params. Otherwise, use an options object.
  • No extra variables.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants