okoyecharles / rails-recipe-app

The 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.

📗 Table of Contents

Click to view contents

1. 📖 About the Project
   • 📹 Video
   • 🛠 Built With
     • Tech Stack
     • Key Features
   • 🚀 Live Demo
2. 💻 Getting Started
   • Setup
   • Prerequisites
   • Install
   • Usage
   • Run tests
   • Deployment
3. 👥 Authors
4. 🔭 Future Features
5. 🤝 Contributing
6. ⭐️ Show your support
7. 🙏 Acknowledgements
8. ❓ FAQ
9. 📝 License

📖 Rails Recipe App

This Recipe App is a ruby on rails application that allows users to create and manage recipes.

📹 Video

🛠 Built With

Tech Stack

Client

• Rails
• Javascript
• Bootstrap

Database

• PostgreSQL

Key Features

This projects aim is to help users create and manage recipes, below are the key features:

• User authentication and authorization
• Creating foods (ingredients) and managing recipes

(back to top)

🚀 Live Demo

• Live Demo Link

(back to top)

💻 Getting Started

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

Prerequisites

• Ruby
• Rails
• Node package manager (npm)

Setup

Github

• Enter this url: https://github.com/okoyecharles/rails-recipe-app in your web browser.
• Once opened navigate to the top left level of the project a green code download button will be visible on the righthand side.
• Select the download Zip option from drop-down menu.
• Once the download is complete you will be able to access my project locally.

Local (Terminal)

  git clone github.com/okoyecharles/rails-recipe-app.git
  cd rails-recipe-app

Install

Install this project with:

Usage

To run the project, execute the following command:

• Run rails s or rails server to start a development server.

Run tests

To run tests, run the following command:

rspec spec will run all the tests. Also, you can run rspec spec/ to run specific tests. You can also run RAILS_ENV=test rspec spec/ to run the tests in test mode.

Deployment

You can deploy this project using:

• Heroku

(back to top)

👥 Authors

👤 Author1

• GitHub: Okoye Charles
• LinkedIn: Okoye Charles
• Twitter: @twitterhandle

(back to top)

🔭 Future Features

• Allow user to be able to generate shopping list for a particular recipe.

(back to top)

🤝 Contributing

Contributions are what makes the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue, feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project. Don't forget to give it a ⭐️

(back to top)

🙏 Acknowledgments

• A big thanks to @microverseinc for the project idea, guidance and inspiration.

(back to top)

❓ FAQ

• What inspired me to create this project?

  • The inspiration for this project came from microverse – a software development bootcamp where you work with teammates remotely on different projects.

(back to top)

📝 License

This project is MIT licensed.

(back to top)