This is the home page / project overview for the OpenRealEstate project and is intended for kind folks who are learning to integrate this system into their own system(s) or to contribute to the project.
OpenRealEstate is a project that models realestate listings for any country. It's based off a common schema, which is then represented by various code languages, packaged up into easy-to-use libraries.
The ethos of this project is to have a common, open and uniform way to represent what a property listing is.
The repositories are organised into a hierachy, following some Namespace and Area conventions:
| Project | Language | Area |
|---|---|---|
| OpenRealEstate | <.NET / Go / Ruby / etc> | <Core / Validation / etc.> |
| Area | Description |
|---|---|
| Core | Domain models that represent the common schema. |
| Transmorgrifiers | Parsers for converting other proprietory formats into an OpenRealEstate domain model. |
| Validation | Validation rules. |
| FakeData | (Optional) A nice helper library to quickly generate fake data. |
e.g.
OpenRealEstate.NET.CoreOpenRealEstate.NET.Transmogrifier.RealestateComAuOpenRealEstate.NET.Transmogrifier.Csv
... etc.
FUN FACT: What is a
Transmogrifier? To quote Wiki: "The Transmogrifier is an invention of Calvin's that would turn one thing into another."
Discussions and pull requests are encouraged :) Please ask all general questions in this repo or pick a specialized repo for specific, targeted issues. We also have a contributing document which goes into detail about how to do this.
Yep, we also have a code of conduct which applies to all repositories in the OpenRealEstate organisation.
- .NET under .NET Standard. Packages available on NuGet.
Check out the contributing page to see the best places to log issues and start discussions.
