📗 Table of Contents

• 📗 Table of Contents
• 📖 Recipe App
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Usage
    • Run tests
    • Deployment
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • ❓ FAQ
  • 📝 License

📖 Recipe App

Recipe App is app in which it allows a user can add different recipe and watch other public recipes.

🛠 Built With

Tech Stack

Client

• Ruby on Rails

Server

• Ruby on Rails

Database

• PostgreSQL

Key Features

• ORM
• ROR
• Linters usage
• Test with Rspec
• Test with Capybara
• Authorization
• Authentication
• MVC

(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:

• Git SCM
• Ruby installed
• Rails installed

Setup

Clone this repository to your desired folder:

git clone https://github.com/biruk-bereka/Recipe-app.git

Or download the ZIP folder.

Install

Once you've cloned the repository simply run:

bundle install
rails db:create
rails db:migrate

And this should open the directory with all the files from the repository on the command line, to open it in your explorer if you're using windows you can run:

explorer .

Usage

To run the project, if you are on the Recipe-app folder path on your terminal you can execute the following command:

code .

This will open Visual Studio Code on the folder you're at.

open terminal and run

  rails server

Run tests

To start tests run:

rspec spec

Deployment

This project is not deployed

(back to top)

👥 Authors

👤 Biruk Bereka

• GitHub: @Biruk-Bereka
• LinkedIn: Biruk Bereka

👤 Nelson Araujo

• GitHub: @NelsonAraujo93
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

• Deploy
• Make improvements with feedbacks

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project you can just cheer me up with a comment 🙂!

(back to top)

🙏 Acknowledgments

Special thanks to my partner.

(back to top)

❓ FAQ

• What is this project main purpose?

  • To learn Ruby on Rails

(back to top)

📝 License

This project is MIT licensed.

(back to top)