Skip to content

hmcts/fact-data-api

Repository files navigation

FaCT Data API

Quality Gate Status Coverage Lines of Code

This is a Java springboot API used in the Find a Court or Tribunal service.

Deploying the application locally

There are two supported ways to deploy the application locally

Using IntelliJ

  1. Ensure you have Java 21 installed on your machine.
  2. Clone the repository to your local machine.
  3. Open the project in IntelliJ.
  4. Start the local database with docker-compose up fact-database -d from the terminal in the project root directory. Postgres will be exposed on port 5999
  5. Run the Application class in Application.java.
  6. You may need environment variables set up for the application to run correctly. You can set these in Intellij by going to Run > Edit Configurations > Environment Variables.
  7. The application should now be running and accessible at http://localhost:8989.

Using Docker

  1. Ensure you have Docker installed and running on your machine.
  2. Clone the repository to your local machine.
  3. Navigate to the project directory in your terminal.
  4. Run the following command to build the local code into a Docker image and deploy the database
    ./deploy_local_docker.sh
  5. The application should now be running and accessible at http://localhost:8989.

License

This project is licensed under the MIT License - see the LICENSE file for details

About

the API for the Find a court or Tribunal service

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 6