Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/mahabubx7/food-hobbies

The JavaScript capstone project is about building your own web application based on an external API. We will select an API that provides data about a topic that we like and then build the webapp around it.
https://github.com/mahabubx7/food-hobbies

capstone-project es6 gh-pages git-flow github-workflows group-project html-css-javascript jest linters webpack

Last synced: 1 day ago
JSON representation

The JavaScript capstone project is about building your own web application based on an external API. We will select an API that provides data about a topic that we like and then build the webapp around it.

Awesome Lists containing this project

README

        


The JavaScript capstone project is about building your own web application based on an external API. We will select an API that provides data about a topic that we like and then build the webapp around it.


# 📗 Table of Contents

- [📗 Table of Contents](#-table-of-contents)
- [📖 \[Js capstone project\] ](#-js-capstone-project-)
- [🛠 Built With `HTML/CSS`,`Nodejs/JavaScript`, and `Webpack`](#-built-with-htmlcssnodejsjavascript-and-webpack)
- [Tech Stack `HTML/CSS` with `JavaScript` \& `Webpack`](#tech-stack-htmlcss-with-javascript--webpack)
- [Key Features ](#key-features-)
- [💻 Getting Started ](#-getting-started-)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Live Preview](#live-preview)
- [Deployment](#deployment)
- [👥 Authors ](#-authors-)
- [🔭 Future Features ](#-future-features-)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [❓ FAQ (OPTIONAL) ](#-faq-optional-)
- [📝 License ](#-license-)

# 📖 [Js capstone project]

The JavaScript capstone project is about building our Food Hobbies web application based on an external API. We will select an API (https://www.themealdb.com/api.php) that provides data about a meals or Foods that we like and then build the webapp around it.

## 🛠 Built With `HTML/CSS`,`Nodejs/JavaScript`, and `Webpack`

### Tech Stack `HTML/CSS` with `JavaScript` & `Webpack`

Client

### Key Features

- **[Clean and Simple Static Webpages]**
- **[Only Raw HTML & CSS with Js]**
- **[Nodejs for development]**
- **[Webpack for static bundler]**

(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:

Check Git is already installed and working:

```sh
git --version
node --version
```

It should not show you any error. And should return the version info.

### Setup

Clone this repository to your desired folder:

Execute this:

```sh
git clone [email protected]:mahabubx7/js-capstone.git
```

### Install

Install this project with:

Install Dependencies:

```sh
cd your-project-folder
npm install
```

### Usage

To run the project, execute the following command:

Execute this:

```sh
npm start
```

### Run tests

To run tests, run the following command:

Testing with Lint-checks:

```sh
npm test
```

### Live Preview
[![Watch the video](https://cdn.loom.com/sessions/thumbnails/529a6efa2f0846d59b4381ac6a6b2810-with-play.gif)](https://www.loom.com/embed/529a6efa2f0846d59b4381ac6a6b2810)

### Deployment

Deployed in `Github Pages`. [Live Preview](https://mahabubx7.github.io/js-capstone/)

(back to top)

## 👥 Authors

👤 **Mahabub**

- GitHub: [@mahabubx7](https://github.com/mahabubx7)
- Twitter: [@mahabub\_\_7](https://twitter.com/mahabub__7)
- LinkedIn: [LinkedIn](https://linkedin.com/in/mahabubx7)

👤 **Fickry**

- GitHub: [@fickryiman](https://github.com/fickryiman)
- Facebook: [@fickry.bil.iman](https://www.facebook.com/fickry.bil.iman)
- LinkedIn: [fickry-bil-iman](https://www.linkedin.com/in/fickry-bil-iman)

(back to top)

## 🔭 Future Features

- [ ] **[Dynamic Renders]**
- [ ] **[Form functionalities]**

(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... please give it a start.

(back to top)

## 🙏 Acknowledgments

I would like to thank... themealdb.com

(back to top)

## ❓ FAQ (OPTIONAL)

- **[Why Webpack?]**

- [It is a static bundler. It helps us to bundle a big and massy web-pages project into a bundled and gives us optimized performance. ]

(back to top)

## 📝 License

This project is [CC License](./LICENSE) licensed.

(back to top)