https://github.com/shadyshawkat/ror-recipe-app

https://github.com/shadyshawkat/ror-recipe-app

Last synced: 26 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/shadyshawkat/ror-recipe-app
• Owner: ShadyShawkat
• Created: 2022-04-11T15:06:20.000Z (over 2 years ago)
• Default Branch: dev
• Last Pushed: 2022-04-14T21:45:43.000Z (over 2 years ago)
• Last Synced: 2024-10-21T13:38:30.136Z (3 months ago)
• Language: Ruby
• Size: 177 KB
• Stars: 2
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Recipe App

> The Recipe app keeps track of all your recipes and ingredients. 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.

![screenshot](./app/assets/images/recipe_app_erd.png)

## Built With

- Ruby

- Ruby on Rails

- OOP

- SQL Postgres

- Bootstrap

## Getting Started

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

- Click on the top right green "code" button.

- On the dropdown menu, choose "download with zip" button.

- After download, extract the zip file and you have the project on your machine.

- Make sure that your PostgreSQL server is running and you have the ability to establish connection with the database.

- Execute `rails db:create` to create the database.

- Run `rails s` to run the application.

## Tests

- If you want to run some unit tests, all you need to do is:

- On your terminal execute:

  > `gem install rspec`

- Run the `rspec` command in this case over the path of `spec/`, the resulting command will look like this:

  > `rspec spec/`

- If you want to run the tests over the entire project, you can execute the following command:

  > `rspec`

## Authors

👤 **Shady Shawkat**

- GitHub: [@ShadyShawkat](https://github.com/ShadyShawkat)

- Twitter: [@ShadyShawkat3](https://twitter.com/ShadyShawkat3)

- LinkedIn: [Shady Shawkat](https://linkedin.com/in/Shady-Shawkat)

👤 **Kerolous Samy**

- GitHub: [@kerolous](https://github.com/keroloussamy)

- Twitter: [@kerolous](https://twitter.com/SamyKerolous)

- LinkedIn: [kerolous](https://www.linkedin.com/in/keroloussamy/)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](../../issues/).

## Show your support

Give a ⭐️ if you like this project!

## Acknowledgments

- Hat tip to anyone whose code was used

- Inspiration

- etc

## 📝 License

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