USRealEstate
/
reso-web-api-reference-server
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
54 Commits 8 Branches 0 Tags 1.3 MiB
Java 97.7%
Shell 2.1%
Dockerfile 0.2%
Go to file
dependabot[bot] ba2d773933
Bump jackson-databind from 2.11.1 to 2.12.7.1 
Bumps [jackson-databind](https://github.com/FasterXML/jackson) from 2.11.1 to 2.12.7.1.
- [Release notes](https://github.com/FasterXML/jackson/releases)
- [Commits](https://github.com/FasterXML/jackson/commits)

---
updated-dependencies:
- dependency-name: com.fasterxml.jackson.core:jackson-databind
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>
 		2022-11-16 01:48:45 +00:00
.github/workflows Progress on saving & changing URI to include version 2021-11-08 11:57:00 -08:00
docker Progress on saving & changing URI to include version 2021-11-08 11:57:00 -08:00
gradle/wrapper Adding in a gradle build process 2021-08-18 16:06:29 -07:00
optional Updates for Postgres 2021-07-22 13:10:22 -07:00
src/main Progress on saving & changing URI to include version 2021-11-08 11:57:00 -08:00
.gitignore Progress on saving & changing URI to include version 2021-11-08 11:57:00 -08:00
Dockerfile Build to DockerHub 2021-11-02 09:58:05 -07:00
LICENSE Initial commit 2021-03-03 18:55:58 -08:00
README.md Progress on saving & changing URI to include version 2021-11-08 11:57:00 -08:00
build.gradle Adding in a gradle build process 2021-08-18 16:06:29 -07:00
build.sh Tweaking scripts for Windows build 2021-11-03 23:46:34 -07:00
docker-compose.yml Updates to fix generic build 2021-10-26 09:46:00 -07:00
env-default Notes and changes for deploying to different environments. 2021-10-26 15:36:30 -07:00
env-default-windows Notes and changes for deploying to different environments. 2021-10-26 15:36:30 -07:00
gradlew Code cleanup and moving object definitions to new folder 2021-08-19 13:55:42 -07:00
gradlew.bat Adding in a gradle build process 2021-08-18 16:06:29 -07:00
pom.xml Bump jackson-databind from 2.11.1 to 2.12.7.1 2022-11-16 01:48:45 +00:00
run.sh needed to make shell scripts executable 2021-03-19 13:24:53 -07:00
settings.gradle Adding in a gradle build process 2021-08-18 16:06:29 -07:00

README.md

RESO Web API and Data Dictionary compliant reference server

Building the server

In order to run your own local server you need a linux / Unix environment with the following dependencies:

  • Maven
  • docker-compose
  • wget or curl

Run the build.sh

This will create everything to run the test server.

Running the server

Run the run.sh

Access the Server

Assuming you're running the server locally, go to http://localhost:8080/core/2.0.0/$metadata
Otherwise, you will have to replace localhost with the IP of your Docker machine.

Running with a different database

If you set the SQL_HOST Environment Variable, then the build script will not build the test database. It will only build the reference server.

You will need to configure the following environment variables, so the server can connect to your custom database.

  • SQL_HOST
  • SQL_USER
  • SQL_PASSWORD

ENVIRNONMENT SPECIFIC NOTES

The build scripts were moved to take place in a Docker container so that they would work consistently across environments.

Windows

In Windows, running under a Bash shell will work, assuming you meet the above requirements. Don't forget to have Docker installed for Windows.

There is an env-default-windows file you should rename to .env before running the build script.

The docker/docker-builder file has a line commented out for Windows users, and a line that needs to be commented out.

MAC

This has not been tested. Anyone wanting to give feedback would be appreciated.

Build Failures

In the case this happens, and you have fixed the source of the error and need to rebuild everything using the build scripts, you should delete any prior Docker containers.

Customizing your setup

You can have your own SQL database. Just copy the env-default file to .env and modify the appropriate properties.