This open-source repository contains code examples related to software documentation that I have developed from scratch 📚
⭐ Please consider starring it on GitHub — your support motivates me to continue improving and expanding this work!
Real&Mate software is designed for prompt implementation and support of real estate agency business processes.
To view the documentation, please visit the Real&Mate Documentation website.
The interface is designed to be user-friendly and visually appealing.
- Automation of providing the client with real estate offers from several agencies.
- Provision of additional services by several service organizations to one client under one contract.
- Several contracts support for one client.
- Agreement decisions are made in real time based on requirement analysis results and depend on the scores calculated on the basis of client data set.
Real&Mate is designed to automatically process an application for a purchase, sale or lease of real estate, for client data analysis and manual setting of processing criteria by manager. GUI and CLI control is available. The software is developed in JavaScript. Interaction between software components is as follows:
- The manager, using the Control Unit, sets up the client assessment methods in the Assessment Unit.
- To create an application, the client manually fills out the form in Client Unit. Personal data are passed from the Client Unit to the Assessment Unit.
- Assessment Unit sends data to the Integration Unit in JSON format using SQL request to get data from a specific external service. When requested, a record with client's application information is generated in the database with primary key which includes application ID and session IDs of connected external services. Sessions of connected external services are generated automatically when application is created. The database genType column specifies methods that form a queue of requests to external services. If there are no specified methods in the column, all available methods will be called. Parameters in requests to different external services may vary.
If the request is retried and the cache is active, no further steps are taken. Assessment Unit gets response from cache.
-
Integration Unit sends request to the external service. The further interaction can be done using technologies such as HTTPS, REST API, SOAP and SQL-queries to the database.
-
External service processing received request and sends a response to the Integration Unit. Before further sending, the Integration Unit checks received data according to two criteria:
- Data must be in JSON format.
- Parameter names from external service must match with parameter names used by Assessment Unit.
If at least one of the criteria is not met:
5.1. The presence of handler for this external service is checked.
5.2. If there is a handler, it's called and data is converted.
Conversion procedures are individual for the handlers of each external service and are configured by developer.
-
Integration Unit sends data in JSON format to Assessment Unit using SQL-query.
-
Assessment Unit sends response with processed data to Control Unit. Manager gets real estate assessment report, manually adjusts the assessment method if necessary, and additionally analyzes real estate parameters.
-
After processing an application for purchase, sale or lease of real estate Control Unit sends to Client Unit the response to the client's request with deal options.
All brands and related information mentioned in the repository are fictitious for the purpose of demonstrating what types of documents I can develop. Any resemblance to real companies is purely coincidental.
| Application | Description | Plugin |
|---|---|---|
| AH Real Estate | File manager | ah-real&mate |
| Cushmaw & Wakefielg | File manager | Natively supported |
| Essev | Text editor | real&mate.essev |
| GSRE | Text editor | real&mate.gsre |
| Notiuv | File manager | Natively supported |
This project utilizes powerful libraries and stylesheets to enhance functionality and ensure consistent styling across different browsers:
-
Dexie.js
- Author: David Fahlander
- License: Apache License, Version 2.0
- Link: Dexie.js Repository
- License Text: Apache License, Version 2.0
-
html2canvas
- Author: Niklas von Hertzen
- License: MIT License
- Link: html2canvas Repository
- License Text: MIT License
-
Normalize.css
- Author: Nicolas Gallagher and Jonathan Neal
- License: MIT License
- Link: Normalize.css Repository
- License Text: MIT License
Real&Mate Documentation is an open-source project. I am committed to a fully transparent development process of the project and appreciate highly any contributions. Whether you are helping me fix bugs, proposing new features or spreading the word — I would love to have you as part of the Real&Mate Documentation community.
Please refer to our Contribution Guidelines and Code of Conduct if you're interested in helping.
This project follows the all-contributors specification. Contributions of any kind are welcome!
You can ask questions and participate in discussions about document-related topics:
- on the Documents Discord channel.
-
on the Documets Matrix channel.
-
on Stack Overflow by including the
realmate-documentstag.
Remember to search for existing questions before creating a new one.
If you run into an issue, please create bug report. This effort is valued and it will help all Documents users.
The tools provided in this repository and on the website https://primesolar.github.io/docs/ for editing and saving content are intended for personal use only. I do not take any responsibility for the use of these tools or the content created or modified using them. All information that is not original or that is not published by me is not associated with me in any way. Users are solely responsible for their actions and the consequences of using the editing and saving features. By using this repository, files associated with this repository, or the website https://primesolar.github.io/docs/, you acknowledge and agree to this disclaimer.
If you have an idea, or you're missing an information that would make documents easier to understand, more accurate and more up-to-date, please submit feature request.
If a similar feature request already exists, don't forget to leave a "+1". If you add some more information such as your thoughts and vision about the feature, your comments will be embraced warmly 🙌
If you enjoy my project and would like to support my work, consider buying me a coffee! Your contributions help me stay energized and motivated to create even more amazing content.
Every cup of coffee you buy not only fuels my passion but also allows me to dedicate more time to developing innovative projects and sharing knowledge. Whether it's a small gesture or a generous contribution, every bit is greatly appreciated!
Click the image to support my work:
Thank you for your support! Together, we can create something wonderful! 💖
LinkedIn @PepsiCo