/rails-group-capstone

Primary LanguageRuby

Food Recipe App

📗 Table of Contents

About the Project

The Food 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
  • Ruby
  • HTML
  • CSS

Key Features

  • User authentication and authorization.
  • User can create, edit, and delete recipes.
  • User can create and delete ingredients.
  • Unit testing
  • Database

🔭 Future Features

  • User can create, edit, and delete recipes.
  • User profiles with customizable avatars and preferences.
  • Integration with external APIs for ingredient information and recipe suggestions.
  • Meal planning features, including weekly menus and scheduling.
  • User ratings and reviews for shared recipes.

💻 Getting Started

To get started with the Recipe App, follow the instructions below:

🛠 Setup

  1. Clone the project repository:

    git clone https://github.com/mahdinoori2000/rails-group-capstone

  2. Navigate to the project folder:

    cd recipe_app

Prerequisites

Before you can run the Blog App, make sure you have the following prerequisites and configurations in place:

  • Ruby: Ensure that Ruby is installed on your machine. You can check if it's installed by running ruby -v in your terminal. If it's not installed, you can download and install it from the official Ruby website.

  • Ruby on Rails: You'll need the Ruby on Rails framework installed. If you don't have it yet, you can install it using the following command:

    gem install rails

  • Code Editor: You should have a code editor like Visual Studio Code (VSCode) installed. You can download VSCode from the official website.

  • Git: Git is essential for version control. Make sure you have Git installed and configured on your system. You can download Git from the official Git website.

  • PostgreSQL: Ensure that PostgreSQL is installed and properly configured on the server where you are developing the project. This project assumes the use of PostgreSQL as the default database. You can download PostgreSQL from the official PostgreSQL website.

  • Ruby on Rails Configuration: Make sure your Ruby on Rails project is configured to use PostgreSQL as the default database.

With these prerequisites and configurations in place, you'll be ready to set up and run the Blog App.

📖 Usage

Follow these steps to use the Blog App:

Open your terminal.

Navigate to the directory where the project files are located:

Copy code

cd /path/to/your/project/files

Start the Rails server:

Copy code

rails server

Open your web browser and go to http://localhost:3000 to access the Blog App.

👥 Authors

👤 Richard Sikaonga

👤 Mahdi Noori

🤝 Contributing

Contributions, issues, and feature requests are welcome! Feel free to check the issues page and contribute to the project.

⭐️ Show Your Support

If you like this project, kindly drop a start ⭐️ for the repository;

(back to top)

🙏 Acknowledgments

I would like to thank the following individuals and organizations for their contribution to this project.

  • I would like to express my heartfelt gratitude to [Microverse]

(back to top)

📜 License

This project is MIT licensed.