Git Product home page Git Product logo

yusufyusie / api-based-webapp Goto Github PK

View Code? Open in Web Editor NEW
1.0 1.0 0.0 2.39 MB

The JavaScript capstone project is about building web application based on an external API. By selecting an API that provides data about this topic and then build the webapp around it. The webapp will have 2 or 3 user interfaces

Home Page: https://yusufyusie.github.io/API-based-webapp/dist/

JavaScript 58.07% HTML 9.78% CSS 32.15%
css html5 javascript

api-based-webapp's Introduction

api-based-webapp Project

๐Ÿ“— Table of Contents

๐Ÿ“– [ api-based-webapp]

This project was created as part of Microverse module 2 week 4 tasks. It gives the student an opportunity to play around with HTML, CSS, and Github. It also allows the student to showcase what they can do to the future employee.

[ api-based-webapp] is a project that allows one to store and manage list of game scores.

๐Ÿ›  Built With

Tech Stack

The tech stack used in this project include CSS, HTML5, Javascript, and Github.

Version Control
Client

Key Features

This project contain the features listed below.

  • [HTML Display Property]
  • [HTML Forms]
  • [CSS Flex/Grid]
  • [CSS Mobile First Design Approch]
  • [Git Branch]
  • [.gitignore file]

(back to top)

๐Ÿš€ Live Demo

-This Project is deployed at Github Pages See Live Demo here

(back to top)

๐Ÿš€ Project Presentation

This project will be presented in the future.

(back to top)

๐Ÿ’ป Getting Started

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

Prerequisites

In order to run this project you need:

Setup

Clone this repository to your desired folder:

  git clone [email protected]:yusufyusie/ api-based-webapp.git
  cd  api-based-webapp
  code .

Install

This project doesn't require installation.

Usage

To run the project, execute the following command: Open index.html with a browser (Chrome, Firefox, Opera, Safari, or Edge)

Run tests

For now no test is implemented.

Deployment

You can deploy this project using: Copying/uploading the project folder's contents to the root of your server.

(back to top)

๐Ÿ‘ฅ Authors

The collaborators of this project include:

๐Ÿ‘ค Yesuf Fenta

๐Ÿ‘ค Christopher Uduekwe

(back to top)

๐Ÿ”ญ Future Features

Features I will add to the project are:

  • [API integration]

(back to top)

๐Ÿค Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

โญ๏ธ Show your support

Readers are encouraged to support this project by contributing.

If you like this project, feel free to use it, leave a comment and follow me for update.

(back to top)

๐Ÿ™ Acknowledgments

I would like to thank microverse for this wonderful opportunity.

(back to top)

โ“ FAQ (OPTIONAL)

2 questions new developers would ask when they decide to use this project.

  • [What languages where used?]

    • [Html5, Javascript, and CSS]
  • [What git control system was used?]

    • [Github]

(back to top)

๐Ÿ“ License

This project is MIT licensed.

(back to top)

api-based-webapp's People

Contributors

yusufyusie avatar chudisoft avatar

Stargazers

 avatar

Watchers

 avatar

api-based-webapp's Issues

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

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

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

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

Suggestion on meal cards

Well done with your project! It looks amazing! The only suggestion we have is to add a shadow for the meal cards when hover so that it will highlight the card.

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

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

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.