9jaswag / property_management

A property management REST API that provides property related information.

Property Management API

Property Management Service is a REST API that provides property related information.

Development

• Ruby on Rails - Rails is a web application development framework written in the Ruby programming language.
• PostgreSQL - PostgreSQL is a powerful, open source object-relational database system with over 30 years of active development that has earned it a strong reputation for reliability, feature robustness, and performance.

Installation

• Clone the repo by running the command below in your Terminal window:

$ git clone [e-mail]:9jaswag/property_management.git

• Change into the property_management directory:

$ cd property_management

• Install all dependencies:

$ bundle install

• Start the development server:

$ rails server

You're set to consume any endpoint at http://localhost:3000/.

API Resource Endpoints

The documentation for this API can be found here.

How to contribute

• Fork this repository.
• Clone it.
• Create your feature branch on your local machine with git checkout -b your-feature-branch
• Push your changes to your remote branch with git push origin your-feature-branch
• Open a pull request against the develop branch, and describe how your feature works

Want to see new features? Open an issue.

Author

Chuks Opia. - Software Developer at Andela.