Giter Club home page Giter Club logo

ashmalzahra / javascript-group-capstone-project Goto Github PK

View Code? Open in Web Editor NEW
0.0 1.0 1.0 462 KB

This JavaScript capstone project is about building web application based on an external API. The API provides data about TV Shows and the app has been built around it.

License: MIT License

HTML 13.87% JavaScript 69.30% CSS 16.83%
api-rest asyncronous best-practices callback code-review es6-modules git-conflicts gitflow html-css-javascript jest

javascript-group-capstone-project's Introduction

๐Ÿ“— Table of Contents

๐Ÿ“– JavaScript Group Project

The JavaScript capstone project is about building my own web application based on an external API. The webapp has 2 user interfaces:

  • A home page showing a list of items that you can "like."
  • A popup window with more data about an item that you can use to comment on.

Built With

(back to top)

Tech Stack

Client
  • CSS
Server
Database
  • N/A

Key Features

  • [Git Flow]
  • [Good HTML, CSS and JS practices]
  • [ES6, modules]

(back to top)

Live Demo

Live Demo Link

๐Ÿ’ป Getting Started

Clone this repository to get started with the project, make sure to configure linters by following the instructions in the Linters README file

Prerequisites

In order to run this project you need:

  • A working computer.
  • Connection to internet.

Setup

  • Clone the folder to your local machine.
  • Open a local copy of the project in your code editor.
  • Open the index.html file from the /dist folder in your browser.
  • Run npm install to install all dev dependencies for Linters, Webpack & Babel.

(back to top)

Usage

  • To run the project, execute the following command:

    • npm run start in your terminal.
  • To run test functions, execute the following command:

    • npm test in your terminal.

(back to top)

Run tests

  • After pushing the changes on github, merge your pull request and let github action process changes and fix errors, if any.
  • For stylelint errors run:sudo npx stylelint "*/.{css,scss}" --fix for automatic fix.

(back to top)

๐Ÿ‘ฅ Authors

๐Ÿ‘ค Ashmal Zahra

๐Ÿ‘ค Jesus Molina

(back to top)

๐Ÿ”ญ Future Features

  • Cool styles will be added in the future

(back to top)

๐Ÿค Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

โญ๏ธ Show your support

Give a โญ๏ธ if you like this project!

(back to top)

๐Ÿ™ Acknowledgments

I would like to thank Microverse for the information provided to build this project.

(back to top)

โ“ FAQ (OPTIONAL)

  • Can I use the project for any purpose?

    • Yes, you can.
  • Is the information saved in any database?

    • No, all data is saved in Local Storage.

(back to top)

๐Ÿ“ License

This project is MIT licensed.

(back to top)

javascript-group-capstone-project's People

Contributors

ashmalzahra avatar sparktan24 avatar

Watchers

 avatar

Forkers

sparktan24

javascript-group-capstone-project's Issues

[3pt] - Add all items counter on the Homepage - Student A

Even if the API gives you the number of items, you will create a specific function to calculate it.

Make sure that the correct number is displayed on the Homepage.

Respect the following rules:

  • Each counter should be implemented as a separate module.
  • A counter function should look for specific DOM elements (e.g. for the comments counter it should look for comments) and make the counting based on what is actually displayed on the page.
  • A counter function should cover all the edge cases you can think about.

[3pt] - Add comments counter - Student B

Even if the API gives you the number of comments you will create a specific function to calculate it.

Make sure that the correct number is displayed on the Comments pop up.

Respect the following rules:

  • Each counter should be implemented as a separate module.
  • A counter function should look for specific DOM elements (e.g. for the comments counter it should look for comments) and make the counting based on what is actually displayed on the page.
  • A counter function should cover all the edge cases you can think about.

[4pt] -Display Comments pop up with selected item's details - Student B

Create a comments popup only with the top section (displaying details of the selected item)

Screenshot 2021-06-27 at 22 10 45

When the popup loads, the webapp retrieves data from the selected API and shows details about the selected item.

Add event to button prepared by your teammate that will open your popup. You need to communicate with your team member to make sure that you do not block each other (most likely the easiest solution is to merge the list of items feature to the dev branch before you try to add that event).

[0.5pt] Find external API - group task

Find an API to base the development of the webapp around it. The API should allow you to

  • Get a list of items with a unique item id (or generate the unique id).
  • For a given item, get detailed information about it.
    choose an APIs that doesn't need authentication. if you select an API that requires authentication, you should implement it on your own. Also, if you select an API that provides image resources your webapp will be more visual.

[4pt] - Display list of items on the Homepage - Student A

Create the main part of the homepage that keeps the layout from the wireframe:

Screenshot 2021-06-27 at 21 50 23

When the page loads, the webapp retrieves data from the selected API and shows the list of items on screen with the basic data (e.g. title + image).

Prepare also "Comments" and "Reservations" buttons. They should be doing nothing - just being displayed.

This task does not include displaying the number of likes for each item.

This task does not include the counter of the items.

Morning Session code review

Hi @Sparktan24,

(Highlights) Good Points: ๐Ÿ‘

  • You documented your work professionally. โœ”
  • Gitflow is used correctly. โœ”
  • The code looks DRY and follows best practices. โœ”

Optional suggestions

  • [OPTIONAL] Kindly consider removing all the commented lines from your codebase โœ”๏ธ๐Ÿ˜ƒ

Cheers and Happy coding!๐Ÿ‘

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.