https://github.com/cmolinan/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, the app should allow you to make them for public access
https://github.com/cmolinan/recipe-app

Last synced: 24 days ago
JSON representation

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, the app should allow you to make them for public access

• Host: GitHub
• URL: https://github.com/cmolinan/recipe-app
• Owner: cmolinan
• Created: 2022-12-12T17:38:33.000Z (almost 2 years ago)
• Default Branch: dev
• Last Pushed: 2022-12-17T16:48:18.000Z (almost 2 years ago)
• Last Synced: 2024-05-10T18:58:06.785Z (6 months ago)
• Language: Ruby
• Size: 677 KB
• Stars: 1
• Watchers: 1
• Forks: 1
• Open Issues: 12
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        




  

  




# 📗 Table of Contents

  Click to view contents

  


    


      📖 About the Project

        


          


            🛠 Built With

            


              
Tech Stack

              
Key Features

            

          
          

        

    

    


      💻 Getting Started

      


        
Prerequisites

        
Install

        
Usage
        

        
Deployment

      

    

    
👥 Author

    
🤝 Contributing

    
⭐️ Show your support

    
🙏 Acknowledgements

    
❓ FAQ

    
📝 License

  


# 📖 Recipe App Group Project with Ruby on Rails 

**Recipe App Group Project with Ruby on Rails** 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.

## 🛠 Built With 

### Tech Stack 

  Server

  


    
Ruby on Rails

  


Database

  


    
PostgreSQL

  


### Key Features 

Note.- This project is in construction ! 

(back to top)


## 💻 Getting Started 

### Prerequisites

In order to run this project you need:

- Ruby

- Rails

- Postgresql 

#### Github

- Enter this url: [https://github.com/cmolinan/Recipe-App](https://github.com/cmolinan/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)

```sh

  git clone https://github.com/cmolinan/Recipe-App.git

```

### Install

Install this project with the steps below:

- After cloning type `cd Recipe-App` to access the project on the terminal.

- Run `bundle install` to install all the required dependancies.

- Create Database with `rails db:create`

- Migrate Database with `rails db:migrate`

- Populate data with `rails db:seed`

### Usage

To run the project, execute the following command:

- Run `rails s` to start a development server.

## 👥 Authors 

👤 **Carlos Molina**

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

👤 **Matias Aguirre**

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

(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](../../issues/).

(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](https://github.com/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](./MIT.md) licensed.

(back to top)