shella12 / RentAnItemBackend

📗 Table of Contents

• 📗 Table of Contents
• 📖 Rent a house API
  • Front End application
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Usage
    • Run tests
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • 📝 License

📖 Rent a house API

The Rent a house API is an API for a house renting app for storing the data of customers and houses and providing user authentication.

Front End application

You can see the Front-end-app's repo here.

Kanban

we are 3 team members:

• Click here to see the Front End Kanban project
• Click here to see the Back End Kanban project

ScreenShots of Kanban boards

🛠 Built With

Tech Stack

Language

• Rails
• Postgresql

Key Features

• Authentication
• View list of houses
• Add houses
• Delete houses
• Add to Favourite

(back to top)

🚀 Live Demo

You can see the live Rent a house API here.

💻 Getting Started

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

Prerequisites

In order to run this project you need:

• Install ruby on your computer or run it with docker
• Have rails installed on your computer

Setup

Clone this repository by using the command line :

• git clone [e-mail]:shella12/RentAnItemBackend.git

First you need to set up the database. To Create a database run: rails db:create and run the migrations rails db:migrate.

Install

Install the bundle packages:

bundle install

Usage

To run the project in your local host, execute the following command:

rails s

NB: You need to create an env file for your database credentials your env file should contain the following

DATABASE_NAME= RentAnItemAPI
RAILS_DATABASE_USER= YOUR_DATABASE_NAME
RAILS_DATABASE_PASSWORD= YOUR_DATABASE_PASSWORD

Run tests

To run tests, run the following command:

  rspec spec

(back to top)

👥 Authors

👤 Zuhra Hashimi

• GitHub: @ZuhRa-HashiMi
• LinkedIn: Zuhra Hashmi
• AngelList: zuhra-hashimi

👤 Ayesha Arshad

• GitHub: @shella12
• Twitter: @Ayesha Arshad
• LinkedIn: Ayesha Arshad

👤 Dicko Allasane

• GitHub: @Trast00
• Twitter: @dickoallassane
• LinkedIn: @dickoallassane
• AngelList: @dickoallassane

(back to top)

🔭 Future Features

• Add rating system
• Updating housing details
• Filter houses
• Add user portfolio
• Add super user

(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 by staring it.

(back to top)

🙏 Acknowledgments

I would like to thank Microverse for the project.

(back to top)

📝 License

This project is MIT licensed.

(back to top)