Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/claudiarojassoto/api_dishes

This repo is a clone of the original group work for this Capstone Project.
https://github.com/claudiarojassoto/api_dishes

css fetch-api javascript jest-tests webpack

Last synced: 7 days ago
JSON representation

This repo is a clone of the original group work for this Capstone Project.

Host: GitHub
URL: https://github.com/claudiarojassoto/api_dishes
Owner: ClaudiaRojasSoto
License: mit
Created: 2023-06-29T16:05:20.000Z (over 1 year ago)
Default Branch: develop
Last Pushed: 2024-01-05T02:22:04.000Z (about 1 year ago)
Last Synced: 2024-12-26T01:21:26.719Z (20 days ago)
Topics: css, fetch-api, javascript, jest-tests, webpack
Language: JavaScript
Homepage:
Size: 399 KB
Stars: 17
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # JavaScriptCapstone



# 📗 Table of Contents

- [JavaScriptCapstone](#javascriptcapstone)

- [📗 Table of Contents](#-table-of-contents)

- [📖 JavaScriptCapstone ](#-javascriptcapstone-)

  - [🛠 Built With ](#-built-with-)

    - [Tech Stack ](#tech-stack-)

    - [Key Features ](#key-features-)

  - [💻 Getting Started ](#-getting-started-)

    - [Project Structure](#project-structure)

    - [Setup](#setup)

    - [Install](#install)

    - [Usage](#usage)

    - [Run tests](#run-tests)

  - [👥 Authors ](#-authors-)

  - [🔭 Future Features ](#-future-features-)

  - [🤝 Contributing ](#-contributing-)

  - [⭐️ Show your support ](#️-show-your-support-)

  - [🙏 Acknowledgments ](#-acknowledgments-)

  - [📝 License ](#-license-)

# 📖 JavaScriptCapstone 

> This is the JavaScript Capstone project, where we built a web application based on an external API. The project is a webapp that revolves around a selected API, providing data about a topic of our choice.

> [Here](https://youtu.be/Hi2MclqUOjU) is the link to the video presentation 

## 🛠 Built With 

### Tech Stack 

  HTML

  


    This project use HTML.



  


  CSS

  


    The CSS is used to provide the design in the whole page.

  


  Linters

  


    The Linters are tools that help us to check and solve the errors in the code

    This project count with three linters: 

    

      HTML

      CSS

      JavaScript

    

  


  Webpack

  


      HTML Webpack Plugin

      Webpack Style/CSS Loader

      Local dev Server

    


  API's

  


    The Themealdb API is for obtain the food items.

    The Innvolvement API is a Microverse API that allows the control of likes and comments.

  





### Key Features 

-   **Webpack Configuration**

-   **HTML Generation**

-   **CSS Styling**

-   **Development Server**

-   **Code Quality**

-   **Modular Structure**

-   **ES6 Syntax**

-   **JavaScript Functionality**

-   **Gitflow**

-   **Send and receive data from API**

-   **Jest testing**

-   **API's**

(back to top)


## 💻 Getting Started 

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

> This project requires Node.js and npm installed on your machine.

-Node.js

-npm

> -Clone this repository to your local machine using:

>  git clone https://github.com/andream2429/JavaScriptCapstone.git

> -Navigate to the project folder:

> cd Leaderboard

> -Install the project dependencies:

> npm install

> o start the development server, run the following command:

> npm start

### Project Structure

> The project follows the following folder and file structure:

> /src: Contains the source files of the application.

> /src/index.js: Main entry point of the JavaScript application.

> /src/style.css: CSS file for the application styles.

> /src/index.html: Base HTML file of the application.

> /dist: Contains the generated production files.

> webpack.config.js: Webpack configuration file.

### Setup

> Clone this repository to your desired folder: https://github.com/andream2429/JavaScriptCapstone.git

### Install

> Install this project with: install WebLint and ESLint

### Usage

> To run the project, execute the following command: just need a web Browser

### Run tests

> To run tests, run the following command: you just need a simple web browser to run this project for a test

## 👥 Authors 

👤 **Andrea Manuel**

- GitHub: [@AndreaM2429](https://github.com/AndreaM2429)

- LinkedIn: [LinkedIn](https://www.linkedin.com/in/andrea-manuel-2b075026a/)

👤 **Claudia Rojas**

-   GitHub: [@githubhandle](https://github.com/ClaudiaRojasSoto)

-   LinkedIn: [LinkedIn](https://www.linkedin.com/in/claudia-soto-260504208/)

(back to top)


## 🔭 Future Features 

-   **[User Authentication]** 

(back to top)


## 🤝 Contributing 

> Contributions, issues, and feature requests are welcome!

> Feel free to check the [issues page](https://github.com/AndreaM2429/JavaScriptCapstone/issues).

(back to top)


## ⭐️ Show your support 

> If you like this project show support by following this account

(back to top)


## 🙏 Acknowledgments 

> -   Microverse for providing the opportunity to learn Git and GitHub in a collaborative environment.

> -   GitHub Docs for providing a wealth of information on Git and GitHub.

(back to top)


## 📝 License 

> This project is [MIT](./LICENSE).

(back to top)