Git Product home page Git Product logo

htetaungkyaw71 / javascript-capstone-project Goto Github PK

View Code? Open in Web Editor NEW
1.0 1.0 1.0 1.2 MB

A seafood restaurant web-app built based on a MealDB API that provides data about Meals. We also used the involvement API provided for the comment and likes functionality, where comments on every meal are saved for review with dates and every click on the heart icon displays the number of likes for each meal. Built with JavaScript

HTML 11.70% JavaScript 62.80% CSS 25.50%

javascript-capstone-project's Introduction

logo

Microverse README Template

๐Ÿ“— Table of Contents

๐Ÿ“– [JavaScript-Capstone-Project] Microverse Group Capstone for module 2

[JavaScript-Capstone-Project] is a Sea food restaurant webapp built based on an external API that provides data about Meals. We also used the involvement API provided for the comment and likes functionality, where comments on every meal are saved for review with dates and every click on the heart icon displays the number of likes for each meal.

๐Ÿ›  Built With

JavaScript HTML CSS

Tech Stack

Webpack Jest JSON

Key Features

Describe between 1-3 key features of the application.

  • [like item]
  • [comment item]
  • [view detail of the item]

(back to top)

Kanban board

Team members

Pull requests with code reviews that I am the proudest of

๐Ÿš€ Live Demo

(back to top)

๐Ÿ’ป Getting Started

Describe how a new developer could make use of your project.

To get a local copy up and running, follow these steps.

Prerequisites

In order to run this project you need: Code editor, web browser and npm

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone [email protected]:Htetaungkyaw71/JavaScript-Capstone-Project.git

Install

Install this project with:

  cd my-project
  npm install

Usage

To run the project, execute the following command:

  npm start

Run tests

To run tests, run the following command:

  npm run test

(back to top)

๐Ÿ‘ฅ Authors

Mention all of the collaborators of this project.

๐Ÿ‘ค Htetaungkyaw

๐Ÿ‘ค Festus Enning

(back to top)

๐Ÿ”ญ Future Features

Describe 1 - 3 features you will add to the project.

  • [search functionality]
  • [add animation]
  • [categories functionality]

(back to top)

๐Ÿค Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

โญ๏ธ Show your support

Write a message to encourage readers to support your project

If you like this project, you can give star this repo

(back to top)

๐Ÿ™ Acknowledgments

Give credit to everyone who inspired your codebase.

I would like to thank...

(back to top)

โ“ FAQ

Add at least 2 questions new developers would ask when they decide to use your project.

  • [Question_1]

    • [Answer_1]
  • [Question_2]

    • [Answer_2]

(back to top)

๐Ÿ“ License

This project is MIT licensed.

NOTE: we recommend using the MIT license - you can set it up quickly by using templates available on GitHub. You can also use any other license if you wish.

(back to top)

javascript-capstone-project's People

Contributors

enning94 avatar htetaungkyaw71 avatar

Stargazers

Roman avatar Progress avatar

Watchers

 avatar

Forkers

enning94

javascript-capstone-project's Issues

[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.

[3pt] - Add reservations counter - Student C

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

Make sure that the correct number is displayed on the Reservations 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).

Module 2 / Block 5 / Day 4 Code-Review

Your project is Looking great!
Congratulations! ๐ŸŽ‰

Highlights

Good quality codes and layout

  • In the comment.js file linked here Try using form.reset( ) to clear the input data after form submission.

[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.

[4pt] - Display Reservations pop up with selected item's details - Student C

Create a reservations 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).

[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.

Morning session peer to peer review

Hi @Enning94 and @Htetaungkyaw71 good job so far ๐Ÿ‘ your project looks excellent and outstanding but there are some little changes I think you should implement in your project.

Acknowledgment

great design

Review

I think you should store your API keys in the .env file, it secures your API and prevents it from hackers

[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.

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.