Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README file #4730

Merged
merged 3 commits into from
Dec 18, 2023
Merged

Update README file #4730

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ef46bf6
Update README file
jaredb96 Dec 15, 2023
877a252
Add note for sbt version
jaredb96 Dec 18, 2023
b1dbdab
Delete accidental line
jaredb96 Dec 18, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 19 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,12 +101,30 @@ The image below shows the cloud vendor agnostic technical architecture for the H

<a href="data-browser/README.md">Please view the README for HMDA Data Browser</a>

## Installations
Before running the HMDA Platform, make sure to have the following installed:
1. Homebrew - https://brew.sh/
2. Docker - ```bash brew install docker ```
3. Docker Desktop - https://docs.docker.com/desktop/install/mac-install/
4. Java (version 13.0.2) for MacOS - [https://www.java.com/en/download/](https://www.oracle.com/java/technologies/javase/jdk13-archive-downloads.html)
5. Scala (version 2.12 for compatibility issues) - ```bash brew install [email protected] ```
6. sdk - https://sdkman.io/install
Next, use sdk to install sbt instead of brew (it won't work with brew) (Note: before install, check what version is currently being used in project/build.properties and install that version or higher):

```bash
sdk install sbt
```
Clone the repo and go into the repo directory:
```bash
git clone https://github.com/cfpb/hmda-platform.git
cd hmda-platform
```

## Running with sbt

The HMDA Platform can run locally using [`sbt`](https://www.scala-sbt.org/) with an [embedded Cassandra](https://doc.akka.io/docs/alpakka-kafka/current/) and [embedded Kafka](https://doc.akka.io/docs/alpakka-kafka/current/). To get started:

```bash
git clone https://github.com/cfpb/hmda-platform.git
cd hmda-platform
export CASSANDRA_CLUSTER_HOSTS=localhost
export APP_PORT=2551
Expand Down