README.md

📗 Table of Contents

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

• 📝 License

📖 Recipe App

Recipe App is an application that allows you to keep track of recipes, inventory and ingredients, generate shoping lists for ingredients you lack for a recipe and share your recipes (depending on their public or private status).

🛠 Built With

Tech Stack

Client

• Ruby on Rails (Views)

Server

• Ruby on Rails

Database

• PostgreSQL

Key Features

Describe between 1-3 key features of the application.

• Add recipes, inventory, ingredients
• Generate shoping lists based on existing ingredients
• Share recipes

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

 gem install rails

Setup

Clone this repository to your desired folder:

Example commands:

  git clone https://github.com/BucurEva87/recipe-app.git

Install

Install this project with:

Example command:

  cd recipe-app
  bundle install

Usage

You will need to create a database and run the migrations. At this moment the project expects you to have a database named recipe_app_development. You can create this database and generate the migrations by running the following command:

  rails db:create && rails db:migrate

To start the server use the following command:

  rails server

Run tests

To run tests, run the following command:

Example command:

  rspec spec

(back to top)

👥 Authors

👤 Eva-Lavinia Bucur

• GitHub: @BucurEva87
• Twitter: @BucurEva
• LinkedIn: Eva-Lavinia Bucur

👤 Krishna Prasad Acharya

• GitHub: @krishnabot
• Twitter: @last_matrix
• LinkedIn: @Krishnabot

(back to top)

🔭 Future Features

Describe 1 - 3 features you will add to the project.

• Register and login users
• Add recipes, inventory and ingredients
• Allow users to share their recipes

(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, please be kind and give it a star. We'd really appreciate ^_^

(back to top)

🙏 Acknowledgments

No acknowledgements are yet due.

(back to top)

📝 License

This project is MIT licensed.

(back to top)