tajulafreen / Recipe-app

[Recipe App] The Recipe app keeps track of all your foods, recipes, and ingredients. It allows you to save ingredients, create recipes, and generate a shopping list based on what you have and what you are missing from a recipe.

📗 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] The Recipe app keeps track of all your foods, recipes, and ingredients. It allows you to save ingredients, create recipes, and generate a shopping list based on what you have and what you are missing from a recipe.

🛠 Built With

Tech Stack

• Ruby
• Rails
• Postgresql

Key Features

• [A login page]
• [Adding foods and creating recipes]
• [A general shopping list view]
• [Use validations for models]
• [Write unit tests for models]
• [Write request tests for models]
• [Set up the view model]
• [Use preprocessed HTML file with embedded Ruby code.]
• [Use layouts and templates for shared content.]

(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 the following installed in your local system

• Ruby
• Git CLI
• Github account

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone [e-mail]:tajulafreen/Recipe-app.git

Install

Install gems with:

  bundle install

Setup database with:

rails db:create
rails db:migrate

Usage

To run the project, execute the following command:

  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

(back to top)

👥 Authors

👤 Foga Kater Amos

• GitHub: @githubhandle
• LinkedIn: LinkedIn

👤 Tajul Afreen

• GitHub: Tajul Afreen
• LinkedIn: Tajul Afreen

🔭 Future Features

• [Build the front end of the system]
• [Style the front end]

(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 leave a STAR to the Github repo

(back to top)

🙏 Acknowledgments

I would like to appreciate Microverse for providing the resources and the platform for us to be a Professional full-stack developer.

(back to top)

📝 License

This project is MIT licensed.

(back to top)