Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/adeola003/javascript_capstone_project
This project is our javascript capstone project, about building your own web application based on an external API.
https://github.com/adeola003/javascript_capstone_project
Last synced: about 1 month ago
JSON representation
This project is our javascript capstone project, about building your own web application based on an external API.
- Host: GitHub
- URL: https://github.com/adeola003/javascript_capstone_project
- Owner: adeola003
- License: mit
- Created: 2023-04-16T09:29:13.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-04-22T11:46:42.000Z (almost 2 years ago)
- Last Synced: 2024-11-11T03:52:08.914Z (3 months ago)
- Language: JavaScript
- Size: 1.12 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
MEALS
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#triangular_flag_on_post-deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ (OPTIONAL)](#faq)
- [📝 License](#license)
**[Meals API]** This project is basic website that display meals from an API, display their instructions, and allow usee to add comment and likes.
Client
- [x] Use JavaScript to make websites dynamic and build basic single page apps.
- [x] Use ES6 syntax and modules, callbacks and promises.
- [x] Used webpack technology.
- [x] Follow Gitflow.
- [x] Send and receive data from an API.
- [x] Make JavaScript code asynchronous.
- [x] Write units tests for a JavaScript app.
- [x] Use AAA pattern for unit tests.
- [x] Used Jest for implementing tests.
- [Comming soon](#)
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
Open terminal on the same folder of the project and run:
```sh
npm install
```
### Setup
Clone this repository to your desired folder:
```sh
git https://github.com/adeola003/Javascript_Capstone_project.git
cd Javascript_Capstone_project
```
### Install
Install this project with:
```sh
npm install
```
### Usage
```
1. download the project from clone
2. open live server for the project
3. You can see it in the browser
```
### Build for production
```
npm run build
```
### Run tests
- ### Linter Tests
To run tests, run the following command:
To check for html errors run:
```sh
npx hint .
```
To check for css errors run:
```sh
npx stylelint "**/*.{css,scss}"
```
To check for js errors run:
```sh
npx eslint .
```
👤 **Abdel-Khafid SALAOU**
- GitHub: [@githubhandle](https://github.com/adeola003)
- Twitter: [@twitterhandle](https://twitter.com/khadaf6)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/abdel-khafid-salaou-a18396161)
👤 **Ndonyi Maurice Djam**
- GitHub: [NdonyiMaurice](https://github.com/citec-47)
- Twitter: [@NdonyiMaurice](https://twitter.com/Ndonyi4)
- LinkedIn: [NdonyiMaurice](https://www.linkedin.com/in/ndonyi-maurice-b5b49b22b/)
- [x] Add test to the project using jest
- [x] Add the live demo for the project
- [x] Add new some features to the project
Contributions, issues, and feature requests are welcome!
Feel free to check the [issue page](https://github.com/adeola003/Javascript_Capstone_project/issues).
If you like this feel free to follow me on github and give this project a star..
- Thanks to the Microverse team for the great curriculum.
- Thanks to my partners for this stunning collab.
- Thanks to the Code Reviewers for the insightful feedbacks.
This project is [MIT](./LICENSE.md) licensed.