ClaudiaRojasSoto / QR_properties_app

QR Properties App is a Ruby on Rails application designed to help in the property selling process . This app generates QR codes that link to a property's location, images, details, and allows scheduling property visits. It's a global platform committed to supporting non-profit property sales across the world.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

QR_properties_app

πŸ“— Table of Contents

πŸ“– QR_properties_app

Welcome to QR_properties_app, an innovative and user-friendly Ruby on Rails solution crafted to revolutionize the property viewing and purchasing experience for a non-profit cause. Our application provides a streamlined interface for generating unique QR codes that link directly to a comprehensive page detailing each property for sale.

By scanning the attached QR code, prospective buyers are directed to a URL showcasing the precise location on an interactive map, detailed high-quality images, key property information, and the option to schedule a visit at their convenience. This tool is built for simplicity and efficiency, allowing users to have all the information they need right at their fingertips.

πŸ›  ER Diagram

ER Diagram soon

πŸ’» Link to Demo

Link to Demo soon

(back to top)

πŸ’» Link to front end

Link to video soon

(back to top)

πŸ›  Built With

Tech Stack

Technologies
Linters
  • Rubocop

Key Features

  • QR Code Generation: Quickly and securely generate QR codes for each listed property.
  • Detailed Viewing: Offer a dedicated page per property featuring a map, high-quality photos, and all relevant details.
  • Visit Scheduling: Enables potential buyers to select and schedule a visit through the platform.
  • Multi-City Support: Accommodates properties located in various cities around the world, providing a global reach.
  • Social Focus: Developed for a non-profit organization, all proceeds and benefits go towards supporting an educative cause.

(back to top)

πŸ’» Getting Started

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

Prerequisites

Before you begin, ensure you have the following prerequisites installed on your system:

  • Ruby: You need Ruby to run the Ruby on Rails application.
  • Bundler: Bundler is used to manage gem dependencies for your Ruby project.

Setup

In your terminal, navigate to the folder of your choice and clone the repository with the following commands:

cd my-folder
git clone https://github.com/ClaudiaRojasSoto/QR_properties_app.git

Install

After cloning the project, change into the project directory:

cd QR_properties_app

Install this project with:

  • gem install rails
  • bundle install

Database Setup

Create and migrate your database with:

rails db:create
rails db:migrate

Usage

To run the project, execute the following command:

rails server
or
rails s

This should start your local server on http://localhost:3000/. Now, you can use the REST API client of your choice to interact with the API.

(back to top)

πŸ”¬ Running Tests

To run tests, navigate to the directory where the project is located on your machine, open your terminal, and follow these steps:

Test Suite

This project contains a suite of unit tests which you can run to ensure everything is functioning as expected. To run these tests, you need RSpec installed.

To install RSpec if you haven't already, run:

gem install rspec

After you've installed RSpec, you can run the tests with:

rspec

(back to top)

πŸ‘₯ Author

πŸ‘€ Claudia Rojas

(back to top)

πŸ”­ Future Features

  • Implement proper user authentication from the front-end to the server
  • Add authorizations to users

(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 feel free to send me corrections for make it better I would feel glad to read your comments. And think If you enjoy gift me a star.

(back to top)

πŸ™ Acknowledgments

  • GitHub for version control and collaboration tools.

(back to top)

❓ FAQ (OPTIONAL)

  • Can I use with a templeate your project?

    • Of course I would feel honored
  • Your project is free license?

    • Yeah, you can use it completely

(back to top)

πŸ“ License

This project is licensed under the MIT License - you can click here to have more details MIT.

(back to top)

About

QR Properties App is a Ruby on Rails application designed to help in the property selling process . This app generates QR codes that link to a property's location, images, details, and allows scheduling property visits. It's a global platform committed to supporting non-profit property sales across the world.

License:MIT License


Languages

Language:Ruby 70.8%Language:HTML 24.0%Language:Dockerfile 2.4%Language:JavaScript 1.7%Language:CSS 0.9%Language:Shell 0.2%