altontonn / Recipe-app

The Recipe app keeps track of all your recipes, ingredients, and inventory. It will allow 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 should allow you to make them

📗 Table of Contents

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

📖 Rceipe App

📖 Description

Describe your project in 1 or 2 sentences.

The Recipe app keeps track of all your recipes, ingredients, and inventory. It will allow 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 should allow you to make them public so anyone can access them.

🛠️ Built With

• Ruby on Rails
• Postgresql
• Capybera
• Rspec
• Cancancan
• Devise

Key Features

• Sign up new user
• Add Recipe
• Add Food
• Generate shoping list

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

• A code editor
• Ruby installed
• Ruby on Rails installed
• Postgresql installed

Setup

Clone this repository to your desired folder: https://github.com/altontonn/Recipe-app.git

  cd my-folder
  

recipe-app

Istall

install this project with: bundle install rails db:create rails db:migrate

Start

To start the application, run the following command

rails server

Run tests

rspec

Usage

To run the project, run ruby <filename> in your terminal

(back to top)

👥 Authors

👤 Ekpenisi Erue Raphael

• GitHub: @eerapheal
• Twitter: @ekpenisiraphael
• LinkedIn: ekpenisi-e-raphael-9678a221a

👤 Newton Alumasa

• Github: altontonn
• Twitter: AlumasaNewton
• Linkedin: newton-alumasa

(back to top)

🔭 Future Features

• Set up associations
• Add basic UI

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

• Fork it
• Create your feature branch (git checkout -b my-new-feature)
• Commit your changes (git commit -am 'Add some feature')
• Push to the branch (git push origin my-new-feature)
• Create new Pull Request.

Feel free to check the issues page.

(back to top)

⭐ Show your support

If you like this project please give it a star

(back to top)

📝 License

This project is MIT licensed.

(back to top)