Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/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.
https://github.com/claudiarojassoto/qr_properties_app
capybara google-drive-api location-iq qr-code rspec rubocop ruby-on-rails telegram-bot-api
Last synced: 17 days ago
JSON representation
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.
- Host: GitHub
- URL: https://github.com/claudiarojassoto/qr_properties_app
- Owner: ClaudiaRojasSoto
- License: mit
- Created: 2024-02-05T22:06:40.000Z (11 months ago)
- Default Branch: develop
- Last Pushed: 2024-02-10T00:31:40.000Z (11 months ago)
- Last Synced: 2024-12-18T17:12:46.485Z (17 days ago)
- Topics: capybara, google-drive-api, location-iq, qr-code, rspec, rubocop, ruby-on-rails, telegram-bot-api
- Language: Ruby
- Homepage:
- Size: 95.7 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# 📗 Table of Contents
- [📗 Table of Contents](#-table-of-contents)
- [📖 QR\_properties\_app ](#-qr_properties_app-)
- [🛠 ER Diagram ](#-er-diagram-)
- [💻 Link to Demo ](#-link-to-demo-)
- [💻 Link to front end ](#-link-to-front-end-)
- [🛠 Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [Key Features ](#key-features-)
- [💻 Getting Started ](#-getting-started-)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Database Setup](#database-setup)
- [Usage](#usage)
- [🔬 Running Tests ](#-running-tests-)
- [Test Suite](#test-suite)
- [👥 Author ](#-author-)
- [🔭 Future Features ](#-future-features-)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [❓ FAQ (OPTIONAL) ](#-faq-optional-)
- [📝 License ](#-license-)
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.
[Link to Demo soon]()
[Link to video soon]()
Technologies
Linters
- Rubocop
- [x] **QR Code Generation**: Quickly and securely generate QR codes for each listed property.
- [x] **Detailed Viewing**: Offer a dedicated page per property featuring a map, high-quality photos, and all relevant details.
- [x] **Visit Scheduling**: Enables potential buyers to select and schedule a visit through the platform.
- [x] **Multi-City Support**: Accommodates properties located in various cities around the world, providing a global reach.
- [x] **Social Focus**: Developed for a non-profit organization, all proceeds and benefits go towards supporting an educative cause.
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:
```sh
cd my-folder
git clone https://github.com/ClaudiaRojasSoto/QR_properties_app.git
```
### Install
After cloning the project, change into the project directory:
```sh
cd QR_properties_app
```
Install this project with:
- gem install rails
- bundle install
### Database Setup
Create and migrate your database with:
```sh
rails db:create
rails db:migrate
```
### Usage
To run the project, execute the following command:
```sh
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.
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:
```sh
gem install rspec
```
After you've installed RSpec, you can run the tests with:
```sh
rspec
```
👤 **Claudia Rojas**
- GitHub: [@ClaudiaRojas](https://github.com/ClaudiaRojasSoto)
- LinkedIn: [@ClaudiaRojas](https://www.linkedin.com/in/claudia-rojas-soto/)
- [ ] **Implement proper user authentication from the front-end to the server**
- [ ] **Add authorizations to users**
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/ClaudiaRojasSoto/QR_properties_app/issues).
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.
- GitHub for version control and collaboration tools.
- **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
This project is licensed under the MIT License - you can click here to have more details [MIT](LICENSE.md).