An open API service indexing awesome lists of open source software.

https://github.com/nkaleth/capstone2_art

This JavaScript capstone project is about building a web application based on an external API. We selected an API from a Museum that provides data about paintings and then we build the webapp around it. This webapp will have 3 user interfaces.
https://github.com/nkaleth/capstone2_art

api-rest conflict-resolution gitflow-workflow html-css-javascript teamwork webpack

Last synced: about 2 months ago
JSON representation

This JavaScript capstone project is about building a web application based on an external API. We selected an API from a Museum that provides data about paintings and then we build the webapp around it. This webapp will have 3 user interfaces.

Awesome Lists containing this project

README

        



logo


# 📗 Table of Contents

- [📗 Table of Contents](#-table-of-contents)
- [📖 LEADERBOARD ](#-Leaderboard-)
- [🛠 Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [Key Features ](#key-features-)
- [🚀 Live Demo ](#-live-demo-)
- [💻 Getting Started ](#-getting-started-)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#deployment)
- [👥 Authors ](#-authors-)
- [🔭 Future Features ](#-future-features-)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [📝 License ](#-license-)

# 📖 Art Gallery

> This JavaScript capstone project is about building a web application based on an external API. We selected an API from a Museum that provides data about paintings and then we build the webapp around it. This webapp will have 3 user interfaces.

## 🛠 Built With

### Tech Stack

> This project uses the following stack :

Client

### Key Features

> Here are some key features of the application :

- **Use callbacks and promises.**
- **Learn how to use proper ES6 syntax.**
- **Use ES6 modules to write modular JavaScript.**
- **Use webpack to bundle JavaScript.**
- **Follow Gitflow.**
- **Solve simple git conflicts.**
- **Send and receive data from an API.**
- **Use API documentation.**
- **Understand and use JSON.**
- **Make JavaScript code asynchronous.**

(back to top)

## 🚀 Live Demo

[Art Gallery Project](https://nkaleth.github.io/Capstone2_art/)

[Video presentation](https://drive.google.com/file/d/1j_LM6YTmhc99GzXe65AKPcWzNPuidfHI/view?usp=share_link)

(back to top)

## 💻 Getting Started

> Clone the repository by clicking on the 'Code' button and copy the link

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

### Prerequisites

In order to run this project you need:

-visual studio
-github

### Setup

Clone this repository to your desired folder:

```sh
mkdir my-folder
cd my-folder
git clone https://github.com/Nkaleth/Capstone2_art.git
```

-

### Install

Install this project with:

```
npm install
```
### Usage I

Change the main branch to the right one, execute the following command:

```sh
git checkout development
```

### Usage II

To run the project, execute the following command:

```sh
npm start
```

### Run tests

To run tests, run the following command:

Example command:

To run the webhint linter

```sh
npx hint .
```

To run the stylehint linter

```sh
npx stylehint "**/*.{css,scss}"
```

To run the ESLint linter

```sh
npx eslint .
```

(back to top)

## 👥 Author

👤 **Francis Uche**

- GitHub: [@francis3400](https://github.com/francis3400)
- Twitter: [@francisBlinkz](https://twitter.com/francisBlinkz)
- LinkedIn: [LinkedIn](https://linkedin.com/in/francis-uche)

👤 **Nilton Segura**

- GitHub: [@Nkaleth](https://github.com/Nkaleth)
- Twitter: [@NoeSeguraL](https://twitter.com/NoeSeguraL)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/nseguralu/)

👤 **Ayomipo Majekodunmi**

- GitHub: [@AyomipoMajek](https://github.com/AyomipoMajek)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/ayomipo-majek-977569185/)

(back to top)

## 🔭 Future Features

- **Implement some UX improvements: include transitions and/or animations, etc.**
- **Implement additional home pages, one page per category of items.**
- **Implement a mobile design for the webapp**

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](../../issues/).

(back to top)

## ⭐️ Show your support

If you like this project follow us and star it!

(back to top)

## 🙏 Acknowledgments

I would like to thank Microverse

(back to top)

## 📝 License

This project is [licensed](./MIT.md) .

(back to top)