asharanjith/Food-planner

📗 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

📖 Food Planner

A project created to learn ROR

🛠 Built With

Tech Stack

Language

• Rails
• Postgresql

Key Features

• Add recipes
• Add foods
• Genererate shopping items

(back to top)

💻 Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

In order to run this project you need:

• Install ruby on your computer or run it with docker
• Have rails installed on your computer

Setup

Clone this repository by using the command line :

• git clone https://github.com/asharanjith/Food-planner.git

Install

Install this project with:

bundle install

Setup database using

rails db:create rails db: migrate

Usage

To run the project, execute the following command:

rails s

Run tests

To run tests, execute the following command:

bundle exec rspec

NB: You need to create an env file for your database credentials

(back to top)

👥 Authors

👤 Asha S Vijayan

• GitHub: @asharanjith
• Twitter: @asha_cep
• LinkedIn: asha-vijayan

(back to top)

🔭 Future Features

• Add dates
• Add weekly meal planner

(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 by staring it.

(back to top)

🙏 Acknowledgments

I would like to thank Microverse for the providing support.

(back to top)

📝 License

This project is MIT licensed.

(back to top)