An open API service indexing awesome lists of open source software.

https://github.com/hassaanjbaig-code/recieps

This project involves building a web application with Ruby on Rails, implementing Devise for user authentication, and creating features such as a food and recipe list, public recipe list, and general shopping list with testing.
https://github.com/hassaanjbaig-code/recieps

rspec-testing ruby ruby-gem rubyonrails

Last synced: 4 months ago
JSON representation

This project involves building a web application with Ruby on Rails, implementing Devise for user authentication, and creating features such as a food and recipe list, public recipe list, and general shopping list with testing.

Awesome Lists containing this project

README

          

# 📗 Table of Contents

- [📗 Table of Contents](#-table-of-contents)
- [📖 recipe-app ](#-recipe_app-)
- [🛠 Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [Key Features ](#key-features-)
- [💻 Getting Started ](#-getting-started-)
- [Prequisites](#prequisites)
- [Setup](#setup)
- [Run tests](#run-tests)
- [👥 Authors ](#-authors-)
- [🔭 Future Features](#future-features)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [📝 License ](#-license-)

# 📖 Recipe App

- This project involves building a web application with Ruby on Rails, implementing Devise for user authentication, and creating features such as a food and recipe list, public recipe list, and general shopping list with testing.

(back to top)

## 🛠 Built With

### Tech Stack

### Key Features

- **User authentication with Devise**
- **Food and recipe lists**
- **Public recipe list**
- **General shopping list view**

(back to top)

## 💻 Getting Started

### Prerequisites

In order to run this project you need:

- To install ruby on rails on your PC. You can read [this](https://guides.rubyonrails.org/) documentation on how to do so
- Know how to navigate directories or folders at the CLI.
- Know how to get a repository's URL(https/ssh) on GitHub.
- You should have a code editor installed, preferably VSCode.

### Setup

In the desired folder or directory in the CLI, run the command:

```JavaScipt
git clone https://github.com/RoyJumah/recipe-app.git
```

Navigate into the cloned folder or repository by running the command:

```JavaScript
cd recipe-app
```

If VsCode is your default code editor, run:

```JavaScript
code .
```

To install all the dependencies, run:

```JavaScript
bundle install
```
After installing all the dependencies with the bundle install command, run the command `rails s` to start the server, and then navigate to http://localhost:3000 in your web browser to access the application.

You are all set up!

(back to top)

### Run tests

To run tests, run the following command:

```sh
$ bundle exec rspec
```

(back to top)

## 👥 Authors

👤 **Roy Jumah**

- GitHub: [@RoyJumah](https://github.com/RoyJumah)
- Twitter: [@\_royissues](https://twitter.com/_royissues)
- LinkedIn: [Roy Jumah](https://www.linkedin.com/in/roy-jumah/)

👤 **Hassaan Baig**

- GitHub: [@HassaanBaig](https://github.com/Hassaanjbaig-code/)
- LinkedIn: [Hassan Baig](https://linkedin.com/in/hassaan-jawwad=baig)

(back to top)

## 🔭 Future Features

- [ ] Ability to search for recipes
- [ ] Integration with payment system for shopping list
- [ ] Social sharing of recipes
- [ ] User profile customization options

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/RoyJumah/recipe-app/issues).

(back to top)

## ⭐️ Show your support

If you like this project you can give it a star

(back to top)

## 🙏 Acknowledgments

We want to thank `Microverse` for providing us with the resources that enabled us to finish this challenge!

(back to top)

## 📝 License

This project is [MIT](./LICENSE) licensed.

(back to top)