Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/ghilain/food-recipee

This is a Capstone project being built in the second module of curriculum at microverse. it's an application that uses the MealDB API to display meals and instructions on how to make the meals. The project also utilizes the Involvement API to update and display comments and likes for the meals
https://github.com/ghilain/food-recipee

css3 eslint html5 javascript npm unit-testing

Last synced: 26 days ago
JSON representation

This is a Capstone project being built in the second module of curriculum at microverse. it's an application that uses the MealDB API to display meals and instructions on how to make the meals. The project also utilizes the Involvement API to update and display comments and likes for the meals

Awesome Lists containing this project

README

        

# Food Recipe

> This is a Capstone project being built in the second module of curriculum at microverse. it's an application that uses the MealDB API to display meals and instructions on how to make the meals. The project also utilizes the Involvement API to update and display comments and likes for the meals

### Click [here](https://ghilain.github.io/food-recipee/dist/) to see deployed live version

### Features implemented so far are:

- Responsive HTML page

### Video link:

[Video link](https://drive.google.com/file/d/1hYH475TLN8UTGZH2Lzavoxx7saMtCG6J/view?usp=sharing)

## Built With

- Lighthouse (An open-source, automated tool for improving the quality of web pages. It has audits for performance, accessibility, progressive web apps, SEO and more).
- Webhint (A customizable linting tool that helps you improve your site's accessibility, speed, cross-browser compatibility, and more by checking your code for best practices and common errors).
- Stylelint (A mighty, modern linter that helps you avoid errors and enforce conventions in your styles).
- ESlint (A mighty, modern linter that helps you avoid errors and enforce conventions in JavaScript codes)
- Webpack

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

### Prerequisites

The basic requirements for building the executable are:

- A working browser application (Google chrome, Mozilla Fire fox, Microsoft edge ...)
- VSCode or any other equivalent code editor
- Node Package Manager (For installing packages like Lighthous, webhint & stylelint used for checking for debugging bad codes before deployment)

# Getting Started

#### Cloning the project

```
git clone
```

## Getting started with Webpack

```
npm install webpack webpack-cli --save-dev
```

## Getting packages and debuging with Stylelint

```
npm install --save-dev [email protected] [email protected] [email protected] [email protected]
```

##### For validation detection using Stylelint Run

```
npx stylelint "**/*.{css,scss}"
```

##### from parent source directory

## Getting packages and debuging with ESlint

```
npm install npm install --save-dev [email protected] [email protected] [email protected] [email protected]
```

##### For validation detection using Stylelint Run

```
npx eslint .
```

##### from parent source directory

## Getting packages and debuging with Webhint

```
npm init -y
npm install --save-dev [email protected]
```

##### For validation detection using Webhint, Run

```
npx hint .
```

##### To Compile and See a live Version, Run
```
npm run build
```
##### Tests

```
npm run test .
```
## License

All source code files are licensed under the permissive zlib license
(http://opensource.org/licenses/Zlib) unless marked differently in a particular folder/file.

## Author

👤 **Ghilain Ishimwe**

- GitHub: [Ghilain Ishimwe](https://github.com/Ghilain)
- Twitter: [@GhilainIshimwe](https://twitter.com/GhilainIshimwe)
- LinkedIn: [Ghilain Ishimwe](https://www.linkedin.com/in/ghilain-ishimwe-067a5b1b4/)