Skip to content

lauriharpf/shipwrecks

Repository files navigation

Shipwrecks.cc

Github Actions Status

Development

Setup

  1. Install Java 11 JDK
  2. Install IntelliJ IDEA
  3. In IntelliJ IDEA, open the project folder
  4. Click Add Configuration... . Add a new Maven configuration with
    • Working directory: (Project folder)
    • Command line: spring-boot:run -Dspring-boot.run.fork=false
  5. Open File -> Project structure. Ensure Project SDK and Project language level are set to 11.

Running the project

  1. Run project via IntelliJ with the created configuration
  2. Optional: Run npm run-script watch in project directory to immediately update UI when JS files are changed
  3. Open http://localhost:8080/ in your browser

To run a production build locally (minifies JavaScript), add PRODUCTION_BUILD=true to Maven configuration's environment variables.

Running tests

  • mvn test runs tests for the Java backend
  • npm test runs tests for the frontend

Deployment

Shipwrecks is hosted at Heroku ( https://shipwrecks.cc/ ). Pushing to master triggers Heroku to deploy a new version after CI has passed.