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. 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
• devise / devise-jwt - for authentication
• cancancan - for authorization

Getting Started

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

Prerequisites

• Ruby ruby-3.1.2 installed
• PostgreSQL dbms running

Setup

• Open your terminal and navigate to the folder you would like to save the project.

• Type these commands into the terminal:

git clone https://github.com/rbanos-mv/recipe-app.git
cd recipe-app
bundle install

• You will need a .env file before you install and run the project. The .env file contains environment variables needed to deploy the webpage. There is a commented .env.example file you can use as a guide to configure your own. Type the following commands into the terminal (or Git Bash, if using Windows) to create your .env file:

cp .env.example .env

rails secret

• Edit file .env

  • Provide the values for the variables
    • DATABASE_HOST
    • DATABASE_USER
    • DATABASE_PASSWORD
    • DEVISE_JWT_SECRET_KEY
  • Assign the value returned by the rails secret to DEVISE_JWT_SECRET_KEY.

• Type this commands into the terminal:

rails db:create
rails db:reset

Run application

• Type this command into the terminal:

rails server

• Open your web browser at http://127.0.0.1:3000/

Testing

• Type this command into the terminal:

rspec

Authors

👤 Roberto A. Baños Alvarez

• GitHub: @rbanos-mv
• Twitter: @RobertoBanosMV
• LinkedIn: Roberto A Baños Alvarez

👤 Rafael E. Guzman Arias

• GitHub: @rega1237
• LinkedIn: Rafael E. Guzman Arias

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

Show your support

Give a ⭐️ if you like this project!

Acknowledgments

• Microverse for the motivation.

📝 License

This project is MIT licensed.