{"id":18685015,"url":"https://github.com/h1alexbel/realo","last_synced_at":"2025-04-12T04:32:52.402Z","repository":{"id":37016666,"uuid":"485104496","full_name":"h1alexbel/realo","owner":"h1alexbel","description":"An experimental REST API Server for Real Estate deals.","archived":false,"fork":false,"pushed_at":"2023-07-20T15:06:16.000Z","size":312,"stargazers_count":8,"open_issues_count":7,"forks_count":1,"subscribers_count":3,"default_branch":"main","last_synced_at":"2023-07-20T16:29:13.325Z","etag":null,"topics":["java","liquibase","postgresql","rest"],"latest_commit_sha":null,"homepage":"https://h1alexbel.github.io/realo/","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/h1alexbel.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-04-24T18:14:32.000Z","updated_at":"2023-07-07T11:17:17.000Z","dependencies_parsed_at":"2023-02-12T21:31:39.583Z","dependency_job_id":null,"html_url":"https://github.com/h1alexbel/realo","commit_stats":null,"previous_names":[],"tags_count":5,"template":null,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/h1alexbel%2Frealo","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/h1alexbel%2Frealo/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/h1alexbel%2Frealo/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/h1alexbel%2Frealo/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/h1alexbel","download_url":"https://codeload.github.com/h1alexbel/realo/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223495135,"owners_count":17154657,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["java","liquibase","postgresql","rest"],"created_at":"2024-11-07T10:20:01.430Z","updated_at":"2024-11-07T10:20:02.119Z","avatar_url":"https://github.com/h1alexbel.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![DevOps By Rultor.com](https://www.rultor.com/b/yegor256/rultor)](https://www.rultor.com/p/yegor256/rultor)\n\u003cbr\u003e\n\n![mvn](https://github.com/h1alexbel/realo/actions/workflows/maven.yml/badge.svg)\n[![Docker](https://img.shields.io/docker/v/abialiauski/realo/latest)](https://hub.docker.com/repository/docker/abialiauski/realo/general)\n[![codecov](https://codecov.io/github/h1alexbel/realo/branch/main/graph/badge.svg?token=SQYcfchyTm)](https://codecov.io/github/h1alexbel/realo)\n[![Hits-of-Code](https://hitsofcode.com/github/h1alexbel/realo?branch=main)](https://hitsofcode.com/github/h1alexbel/realo/view?branch=main)\n![GitHub pull requests](https://img.shields.io/github/issues-pr/h1alexbel/realo)\n\nRealo is an experimental engine for Real Estate deals.\n\n## Glossary\n1.User - the user/customer of the application.\n\n2.Provider - person, or an organization which can provide market with estates and its building.\n\n3.Estate - an extensive area of land in the country, usually with a large house, owned by one person, family, or organization.\n\n4.Announcement - a formal public statement about a estate on some resources/sites.\n\n# Prerequisites\n\nYou need to have [```Docker```](https://www.docker.com), ```Java 11+```, and ```Maven 3.3+``` installed.\n\n# Quick Start\n\nRun this script to start 2 containers: Realo-API,\nand [PostgreSQL](https://www.postgresql.org)\n\n```shell\n$ sh up.sh\n```\n\nThen, go to ```POST```\n```localhost:8080/api/v1/auth/login```\nWith the next body:\n\n```json\n{\n  \"username\": \"api_admin\",\n  \"password\": \"password\"\n}\n```\n\nYou will receive [Access](https://www.wikiwand.com/en/Access_token) token.\nYou will need them using the Realo API.\nAccess Token expires in 5 minutes.\n\n# Endpoints\nAPI Management docs placed here: ```/swagger-ui```\n\n# Security\n\nRealo is a secured API. We are using [```JWT```](https://www.wikiwand.com/en/JSON_Web_Token) token\nto authenticate and authorize users.\nSo, each request to the secured resources should go with the ```Autorization``` header.\ne.g.:\n\n```\n-X Authorization: eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbkBtYm9vay5jb20iLCJyb2xlIjoiQURNSU4iLCJpYXQiOjE2NzE0NjA4OTcsImV4cCI6MTY3MTQ2MTE5N30.O8m05s3xEkhroTFjh9xdaCUMdUB1B-pKEu9f0TaLb1s\n```\n\nAlso, we have 3 types of authority: ```USER```, ```AGENT``` and the ```ADMIN```\n\n# Want to contribute?\n\nDon't be shy. Just submit an [issue](https://github.com/h1alexbel/realo/issues) or open\na [pull request](https://github.com/h1alexbel/realo/pulls).","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fh1alexbel%2Frealo","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fh1alexbel%2Frealo","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fh1alexbel%2Frealo/lists"}