Giter Club home page Giter Club logo

fmanimashaun / artwork-listing-app Goto Github PK

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

This project will be a group capstone project to create a single-page web application based on the Art Institute of Chicago's API. The application will be built with webpack 5 and Sass, and provide an intuitive user interface to view artworks from the Art Institute of Chicago. Additionally, the application will use Jest to test.

Home Page: https://fmanimashaun.github.io/artwork-listing-app

License: MIT License

JavaScript 53.09% HTML 18.83% SCSS 28.08%
api html5 json-api rest-api sass spa webpack5

artwork-listing-app's Introduction

Artwork Listing App (API-based webapp)

๐Ÿ“— Table of Contents

๐Ÿ“– Overview

This project will be a group capstone project to create a single-page web application based on the Art Institute of Chicago's API. The application will be built with webpack 5 and Sass, and provide an intuitive user interface to view artworks from the Art Institute of Chicago. Additionally, the application will use Jest to test all JavaScript functions.

The project involves developing a web application from scratch. As part of this, the group will need to research and familiarize themselves with the Art Institute of Chicago's API, as well as webpack 5 and Sass. The group will then implement a functional design with an intuitive user interface, HTML formatting, and stylesheet creation. Furthermore, the project will incorporate testing with Jest.

By the end of the project, the team should have a completed web application that allows users to view artifacts from the Art Institute of Chicago, with the code tested using Jest.

Project Objectives

API

For this project, we explore the use of Art Institute of Chicago API to build a web application that allows users to view a list of artworks and like them using Involvement API. The API provides data about artworks and their authors.

For this particular project, we will use the following endpoints:

https://api.artic.edu/api/v1/artworks?page=2&limit=100&fields=id,title,artist_display,date_display,main_reference_number,image_id

User Stories

  • The following interfaces were built:
    • The home page.
    • The comments popup.
    • The reservations popup
  • the given layout was followed with additional personalization(colors, typographies, spacings, etc).
  • Home page
    • When the page loads, the webapp retrieves data from:
      • The selected API and shows the list of items on screen.
      • The Involvement API to show the item likes.
    • Remember that your page should make only 2 requests:
      • One to the base API.
      • And one to the Involvement API.
    • When the user clicks on the Like button of an item, the interaction is recorded in the Involvement API and the screen is updated.
    • When the user clicks on the "Comments" button, the Comments popup appears.
    • When the user clicks on the "Reservations" button, the Reservations popup appears (only for the groups of 3 students).
    • Home page header and navigation similar to the given mockup.
    • Home page footer similar to the given mockup.
  • Comments popup
    • When the popup loads, the webapp retrieves data from:
      • The selected API and shows details about the selected item.
      • The Involvement API to show the item comments.
    • When the user clicks on the "Comment" button, the data is recorded in the Involvement API and the screen is updated.
  • Reservations popup (only for the groups of 3 students)
    • When the popup loads, the webapp retrieves data from:
      • The selected API and shows details about the selected item.
      • The Involvement API to show the item reservations.
    • When the user clicks on the "Reserve" button, the data is recorded in the Involvement API and the screen is updated.
  • We have counters in all the interfaces that show:
    • The number of items (home).
    • The number of comments (comments popup).
    • The number of reservations (reservations popup) - only for the groups of 3 students.
    • Each counter was implemented as a separate module.
    • A counter function looks 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.
    • The counter function covers all the edge cases you can think about.

๐Ÿ›  Built With

Tech Stack

Key Features

  • Use ES6 modules, with import and export.
  • Use callbacks and promises.
  • Use Webpack to bundle JavaScript.
  • Write units tests for a JavaScript app.
  • Follow Gitflow.
  • Send and receive data from an API.
  • Use API documentation.
  • page counter.

๐Ÿš€ Live Demo

Live Demo Link Video Demo Link

๐Ÿ’ป Getting Started

  • [Optional] Install git bash to your machine to enable you to clone this repo.
  • install Visual Studio to be able to host a local live version.
  • Install a browser to view the local live version.

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

Setup

  • Open your GitHub account the repository's link

Prerequisites

  • Internet connection
  • A github account

Install

  • copy the repo's link and clone it by writing git clone https://github.com/fmanimashaun/artwork-listing-app.git on your git bash terminal.
  • npm install to install the dependencies.

Run tests

  • You can check for errors by running linter tests found in the github flows.

Deployment

  • run npm run start to run it locally.

Authors

๐Ÿ‘ค Engr. Animashaun Fisayo

๐Ÿ‘ค Gerson Sanchez

๐Ÿ‘ค Francis Uche

๐Ÿค Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

โญ๏ธ Show your suppor

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

๐Ÿ“ License

This project is MIT licensed.

artwork-listing-app's People

Contributors

fmanimashaun avatar

Watchers

 avatar

artwork-listing-app'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.

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

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

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

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.