README.md

RECIPE-APP

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Run tests
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 License

📖 RECIPE WEB APP

• This project about building a Recipe web app using Ruby on Rails and PostgreSQL

🛠 Built With

• Ruby on Rails (RoR)
• PostgreSQL

(back to top)

Key Features

• Generate Rails Models
• Generate Rails Controllers
• Write Unit Tests/Specs
• Write Integration Tests with capybara gem
• Use Devise gem for authentication

💻 Getting Started

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

Prerequisites

In order to run this project you need Ruby version >= 3.2

  Install Ruby & Ruby on Rails on your local machine

Setup

Clone this repository to your desired folder:

  RUN git clone https://github.com/fezzopro/recipe_app.git
  RUN cd recipe_app

Install

Install System dependencies with:

  RUN bundle install
  RUN rails db:create
  RUN rails db:migrate

Usage

To run the project, execute the following command:

  RUN rails server
    OR
  RUN rails s

Run tests

To run tests and check linters linter, run the following command:

  RUN rubocop -A
  RUN rspec

(back to top)

👥 Authors

👤 Felix KAMANA

• GitHub: @githubhandle
• LinkedIn: LinkedIn

👤 Paul Tesfaye

• GitHub: @githubhandle
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

• Deploy Ruby on Rails Application.

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

(back to top)

⭐️ Show your support

If you like this project kindly give it a star⭐️.

(back to top)

🙏 Acknowledgments

I would like to thank Microverse for the idea for this project.

(back to top)

📝 License

This project is MIT licensed.

(back to top)