/Recipe_app

Primary LanguageRubyMIT LicenseMIT

📖 [Recipe App]

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.

🛠 Built With

Tech Stack

BackEnd
Test
Database

Key Features

  • [Add Recipe] - Add Recipe.
  • [Display all recipe foods] - Display all recipe foods.
  • [Add inventory] -Add inventory.

(back to top)

🚀 Live Version

(back to top)

💻 Getting Started

If you dont have Ruby installed on your computer, you can download it from here.

If you dont have Rails installed on your computer, you can download it from here.

If you dont have PostgreSQL installed on your computer, you can download it from here.

If you have installed git you can clone the code to your machine, or download a ZIP of all the files directly.

NOTE: You may need to run the following commands in the project directory to install the required gems and run the application:

  1. Install gem packages with:
bundle install
  1. Open the config/database.yml file in the project directory and change the username and password to your PostgreSQL username and password. Edit the default section of the file to look like this:
  default: &default
  adapter: postgresql
  encoding: unicode
  # For details on connection pooling, see Rails configuration guide
  # http://guides.rubyonrails.org/configuring.html#database-pooling
  pool: <%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %>
  username: <your PostgreSQL role username>
  password: <your PostgreSQL role password>
  1. Create the database with:
rails db:create
  1. Start the development server
rails server
  1. Open the app in your browser at http://localhost:3000

Run tests

To run tests, run the following command: rspec

(back to top)

👥 Authors

👤 Edi Sipka

👤 Riya Bulia

👤 Moathal Kachi

(back to top)

🔭 Future Features

  • [Update recipe]
  • [Update inventory]

(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 give as a star! ⭐️

(back to top)

🙏 Acknowledgments

  • Hat tip to anyone whose code was used
  • Inspiration
  • Microverse

(back to top)

❓ FAQ

  • [How I can run this project?]

    • [After cloning repository, run rails server.]

  • [Can I add likes on post?]

    • [You can add likes and comments on a post.]

(back to top)

📝 License

This project is MIT licensed.

NOTE: we recommend using the MIT license - you can set it up quickly by using templates available on GitHub. You can also use any other license if you wish.

(back to top)