Enoisong/Recipe-app

Recipe_app

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• ❓ FAQ (OPTIONAL)
• 📝 License

📖 Recipe_app

[Recipe_app] is a web application that allows users to easily store, organise and share recipes. Users can create personalized recipe boxes to save their favourite recipes for quick access.

🛠 Built With

Tech Stack

This database is created using:

• Ruby on Rails
• Postgres

recipe_app

• PostgreSQL

Key Features

• [User Profile]
• [Login page and registration page]
• [Food list]
• [Recipes list]
• [Public recipe list]
• [Recipe details]
• [General shopping list view]
• [N+1 queries]
• [Navigation menu]
• [Unit and integration tests]

(back to top)

💻 Getting Started

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

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone https://github.com/Kel-nana/Recipe-app.git

Install

Install this project with:

cd Recipe_app
bundle install

Usage

In order to run this project you need:

install ruby
ruby --version
install sqlite3
sqlite3 --version
gem install rails
rails --version

Start the server by running the following command:

rails server

(back to top)

👥 Author

👤 Author1

• GitHub: @githubhandle
• Twitter: @twitterhandle
• LinkedIn: LinkedIn

👤 Author2

• GitHub: @Kel-nana
• Twitter: @kelvin-irungu
• LinkedIn: @kelvin-irungu

🔭 Future Features

• [More Users Interation]
• [Animation ]

(back to top)

🤝 Contributing

Contributions, issues, as well as feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project, kindly leave a comment below and share it with someone who enjoys coding! or still give me a ⭐️!

(back to top)

🙏 Acknowledgments

• Thanks to the Microverse team for the great curriculum.
• Thanks to the Code Reviewer(s) for the insightly feedbacks.
• A great thanks to my coding partner(s), morning session team and standup team for their contributions.

(back to top)

📝 License

This project is MIT licensed.

(back to top)