README.md

Javascript Capstone Project

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• ❓ FAQ
• 📝 License

📖 [JavaScript Capstone]

A web application based on using external API's

🛠 Built With HTML, CSS, JavaScript & API's

Tech Stack

• linters
• HTML
• CSS
• JS
• GIT/Github
• API
• Involvement API

Key Features

[Use JavaScript to make websites dynamic and build basic single page apps.] [Write units tests for a JavaScript app] [Send and receive data from an API]

(back to top)

🚀 Live Demo

• Loom Video
• Live Demo

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

- VSCode or any other IDE.
- node.js(preferable).
- browser to deploy.
- GitHub/Git.

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone https://github.com/Rudy-Menekam/Javascript-Capstone-project.git

Install

Install this project with:

  cd my-project
  npm init -y

Usage

To run the project, execute the following command:

  npm run build
  npm start

Deployment

You can deploy this project using:

git and github pages

(back to top)

👥 Authors

👤 Rudy Menekam

• GitHub: @githubhandle
• Twitter: @twitterhandle
• LinkedIn: linkedIn

👤 Alice Mirigo

• GitHub: Alice Mirigo
• Twitter: @Gathonimirigo
• LinkedIn: Alice

(back to top)

🔭 Future Features

Add more fuctionalities like search

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project, you are welcomed to star and fork it. You can also share your ideas for future features.

(back to top)

🙏 Acknowledgments

I would like to thank Microverse, and theMealDB who are owners of the API documentation used for this project.

(back to top)

❓ FAQ

• [Do you need node installed to run this project?]
  • [Yes]
• [Can i pick up and issue and work on?]
  • [Yes]

(back to top)

📝 License

This project is MIT licensed.

(back to top)