kennankole/vegan-meals

This project uses meals API to create a vegan meal website that allows users to query vegan meals and get their tips on how to cook it.

📗 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 (OPTIONAL)
• 📝 License

📖 [Vegan Foods]

[Vegan Foods] is an onlne platform where users can query about their favorite vegan meal and get tips on how to cook it

Project tour

🛠 Built With

Tech Stack

Client

• React.js

Database

• PostgreSQL

Key Features

• [Search meals and read about them]

(back to top)

🚀 Live Demo

• Live Demo Link

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

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone https://github.com/kennankole/vegan-meals.git

Install

Install this project with:

  cd vegan-meals
  npm install

Usage

To run the project, execute the following command:

  npm start server

Run tests

To run tests, run the following command:

  npm test

(back to top)

👥 Authors

👤 Author 1

• GitHub: @kennankole
• Twitter: @obwombe_kennedy
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

• [Meal rating]
• [Recipe sharing]
• [Meal sharing]

(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 kindly give it a ⭐️

(back to top)

🙏 Acknowledgments

I would like to thank the following parties for inspiring this codebase

Tasty API for providing the data Nelson Sakwa for inspiring the UI design

(back to top)

(back to top)

📝 License

This project is MIT licensed.

(back to top)