kessio / Rent-a-house-backend

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• ❓ FAQ (OPTIONAL)
• 📝 License

📖 Final-Capstone

This project is a group Final Capstone Project based on an app to rent houses. It is a fullstack application built with rails for the backend and react for the frontend

Final Capstone Project is based on an app to rent houses. Users can see a list of houses that he / she can select with full description page of the house. He/she can add house and delete. He/She can also add favourite house.

🛠 Built With

Tech Stack

Client

• Rails

Server

• Ruby

Database

• PostgreSQL

Key Features

• Login Functionality
• Navigation panel with links to houses, my favourite, add house, delete house
• Main page to see list of houses
• Front-End Link
• API Documentation

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

• npm
• Ruby
• Ruby on Rails
• Postgresql

Setup

Clone this repository to your desired folder:

cd my-folder
git clone https://github.com/kessio/Rent-a-house-backend.git

Install

Install this project with:

  cd my-project
  bundle install
  npm install

Usage

To run the project, execute the following command:

  rails db:create
  rails db:migrate
  rails db:seed
  rails s

This will run your rails server for the backend, next use the front-end repo instructions to install and run the front-end.

Run tests

To run tests, run the following command:

  bin/rails test test/models/article_test.rb

Deployment

• Coming soon...

(back to top)

👥 Authors

Mention all of the collaborators of this project.

👤 Sharon Kessio

• GitHub: @kessio
• Twitter: @kessio_sharon
• LinkedIn: LinkedIn

👤 Abdulai Samuel Moiwa

• GitHub: @Moiwa
• LinkedIn: LinkedIn
• Twitter: SamuelMoiwa

👤 Emem Cookey

• GitHub: @ecekpo
• LinkedIn: LinkedIn
• Twitter: @ememcookey

(back to top)

🔭 Future Features

Describe 1 - 3 features you will add to the project.

• User Authentication
• Design User Interface
• CRUD Operations

(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 leave a star on this repository

(back to top)

🙏 Acknowledgments

I give credit to Alexey Savitskiy on Behance. who's design was used in the creation of this project

(back to top)

##License This project is MIT Licensed ![license]

❓ FAQ (OPTIONAL)

• What is the difference between using rake and rails?

  • Rails core team decided to have consistency by enabling rails command to support everything that rake does.

For example in Rails 5 commands like db:migrate, db:setup, db:test etc which are part of rake command in Rails 4 are now being supported by rails command. However you can still choose to use rake to run those commands similar to how they were run in Rails 4. This is because Rails community has introduced Rake Proxy instead of completely moving the command options from rake to rails.

What happens internally is that when rails db:migrate command is executed, Rails checks if db:migrate is something that rails natively supports or not. In this case db:migrate is not natively supported by rails, so Rails delegates the execution to Rake via Rake Proxy.

If you want to see all the commands that is supported by rails in Rails 5 then you can get a long list of options by executing rails --help.