https://github.com/piercel2022/recipe_app

https://github.com/piercel2022/recipe_app

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/piercel2022/recipe_app
• Owner: Piercel2022
• License: gpl-2.0
• Created: 2023-04-17T13:05:25.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-08-25T14:31:33.000Z (over 1 year ago)
• Last Synced: 2024-12-06T03:53:42.053Z (about 2 months ago)
• Language: Ruby
• Size: 434 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 📗 Table of Contents

- [📖 About the Project](#about-project)

  - [🛠️ Built With](#built-with)

    - [Tech Stack](#tech-stack)

    - [Key Features](#key-features)

- [💻 Getting Started](#getting-started)

  - [Setup](#setup)

  - [Prerequisites](#prerequisites)

  - [Install](#install)

  - [Usage](#usage)

  - [Run tests](#run-tests)

  - [Deployment](#triangular_flag_on_post-deployment)

- [👥 Authors](#authors)

- [🔭 Future Features](#future-features)

- [🤝 Contributing](#contributing)

- [⭐ Show your support](#support)

- [🙏 Acknowledgements](#acknowledgements)

- [📝 License](#license)

# 📖 Recipe App 

# 📖 Description 

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

- Postgresql

- Capybera

- Rspec

- Cancancan

- Devise

### Key Features 

- Sign up new user

- Add Recipe

- Add Food

- Generate shoping list

(back to top)


## 💻 Getting Started 

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

### Prerequisites

In order to run this project you need:

- A code editor

- Ruby installed

- Ruby on Rails installed

- Postgresql installed

### Setup

Clone this repository to your desired folder:

https://github.com/altontonn/Recipe-app.git

```

  cd my-folder

  

```

recipe_app

### Istall

install this project with:

  bundle install

  rails db:create

  rails db:migrate

### Start 

To start the application, run the following command

```

rails server

```

### Run tests 

```

rspec

```

### Usage

To run the project, run `ruby ` in your terminal

(back to top)


## 👥 Authors 

👤 **Pierre Celestin Moussa**

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

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

- LinkedIn: [@pierrecelestinmax](https://linkedin.com/in/pierrecelestinmax)

👤 **Newton Alumasa**

- Github: [altontonn](https://github.com/altontonn/)

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

- Linkedin: [newton-alumasa](https://www.linkedin.com/in/newton-alumasa/)

(back to top)


## 🔭 Future Features 

- **Set up associations**

- **Add basic UI**

(back to top)


## 🤝 Contributing 

##### Contributions, issues, and feature requests are welcome!

- Fork it

- Create your feature branch (git checkout -b my-new-feature)

- Commit your changes (git commit -am 'Add some feature')

- Push to the branch (git push origin my-new-feature)

- Create new Pull Request.

Feel free to check the [issues page](https://github.com/Piercel2022/recipe_app/issues).

(back to top)


## ⭐ Show your support 

If you like this project please give it a star

(back to top)


## 📝 License 

This project is [MIT](https://github.com/Piercel2022/recipe_app/blob/dev/LICENSE) licensed.

(back to top)