📗 Table of Contents

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

📖 [Recipe App]

Recipe App

The Recipe app keeps track of all your foods, recipes, and ingredients. It allows you to save ingredients, keep track of what you have, create recipes, and generate a shopping list based on what you have and what you are missing from a recipe. Also, since sharing recipes is an important part of cooking, the app allows you to make them public so anyone can access them.

Built With

• Ruby
• Rails
• Postgresql

Tech Stack

Server

• Ruby

Key Features

• [A login page]
• [A registration page]
• [A general shopping list view]

(back to top)

🚀 Live Demo

• Live Demo Link

(back to top)

💻 Getting Started

To run this project, take a copy of the code and follow the instruction below.

Prerequisites

You need Ruby v3+, Rails v7+ and Postgresql installed on your machine.

Setup

Clone the project

Install gems with:

bundle install

Setup database with:

rails db:create
rails db:migrate

Usage

Start server with:

rails server

Visit http://localhost:3000/ in your browser.

Run tests

Install npm with:

Install rspec with:

bundle install

and

rails generate rspec:install

run the test with:

rspec spec

Open API documentation

rails server

Visit http://localhost:3000/api-docs in your browser.

Usage

• Run rails server to run the app.

👥 Authors

👤 Kaung Myat Kyaw

• Portfolio: Portfolio
• GitHub: GitHub
• Twitter: Twitter
• LinkedIn: LinkedIn

👤 Anthony Martin

• GitHub: GitHub
• Twitter:Twitter
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

• [Inventories list]
• [Inventory details]
• [Inventory shopping list]

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

Show your support

Give a ⭐️ if you like this project!

📝 License

This project is MIT licensed.

(back to top)