HandyMate Backend 🏠️🛠️

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Key Features
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
• 📓 API Documentation
• 👥 Authors
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 License

📖 HandyMate-Backend

HandyMate Backend is a Rails project which gives the API for the HandyMate Frontend.

🛠 Built With

This app is build with Ruby on Rails and Postgresql.

Tech Stack

Ruby

Ruby on Rails

Postgresql

React

Redux

Key Features

• Authentication
• Authorization
• CRUD

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

• Mac or PC
• Install Ruby
• Install Rails
• Install Postgresql
• Install yarn
• Understanding of Ruby

App Screenshot

Front-end Repository

• Here is the link of the Front-End

Initial State of Kanban Board

Setup

• Clone this repository to your desired folder:

   git clone https://github.com/PrantoshB/HandyMate-Backend.git

• Navigate into the cloned folder

cd HandyMate-Backend

Install

Install this project with:

  bundle install

• Set up the database change the username and password of your postgres account in

config/database.yml

rails db:create db:migrate db:seed

• Start the server

rails s

• Run the tests

rspec ./spec/models

(back to top)

📓 API Documentation

• Run the server with rails s command
• The open https://localhost:3000/api-docs in your browser.

(back to top)

👥 Authors

👤 Yetemegn Lemma

• GitHub: @githubhandle
• Twitter: @twitterhandle
• LinkedIn: [LinkedIn](* lemma19yet@gmail.com)

👤 Jacinta Ngwu

• GitHub: @JacintaNgwu
• Twitter: @jacinta_ngwu
• LinkedIn: jacinta_ngwu

👤 Haliljon Juraboev

• GitHub: @githubhaliljon
• Twitter: @twitterhaliljon1
• LinkedIn: LinkedIn

👤 Utsargo Roy

• GitHub: @utsargo
• Twitter: @royutsargo
• LinkedIn: LinkedIn

👤 Prantosh Biswas

• GitHub: @PrantoshB
• Twitter: @prantalks
• LinkedIn: Prantosh Biswas

(back to top)

• GitHub: @utsargo
• Twitter: @royutsargo
• LinkedIn: LinkedIn

(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, please give a ⭐️

(back to top)

🙏 Acknowledgments

I would like to thank:

• Murat Korkmaz for a beautiful, efficient, and accessible user interface Design.

(back to top)

📝 License

This project is MIT licensed.

(back to top)