Skip to content

Latest commit

 

History

History
97 lines (69 loc) · 2.93 KB

DEVELOPMENT.md

File metadata and controls

97 lines (69 loc) · 2.93 KB
Raw

Install Prerequisites

Clone this repo

git clone [email protected]:tolgee/tolgee-platform.git

Run the stack

  1. Run backend
    • With the prepared Idea run configuration Backend localhost
    • With command line: 
      ./gradlew server-app:bootRun --args='--spring.profiles.active=dev'
  2. Run frontend
    • With the prepared Idea run configuration Frontend localhost
    • With command line: 
      cd webapp && npm ci && npm run start
  3. Open your browser and go to http://localhost:3000.

Testing

The backend of Tolgee is tested with unit and integration tests.

Backend testing

To run backend tests, you can run Gradle test task

./gradlew test

Or you can select any integration test the code and run it via Idea CE or Idea Ultimate. It should just work out of the box.

E2E testing

Follow the steps in the E2E readme.

Backend configuration

To configure Tolgee, create an empty file backend/app/src/main/resources/application-dev.yaml. In this file, you can override default configuration properties. You can check application-e2e.yaml for inspiration. To learn more about externalized configuration in Spring boot, read the docs.

Since we set the active profile to dev, Spring uses the application-dev.yaml configuration file.

Updating the database changelog

Tolgee uses Liquibase to handle the database migration. The migrations are run on every app startup. To update the changelog, run:

./gradlew diffChangeLog

Troubleshooting updating the changelog

If you misspell the command and run diffChangelog, it will find the command, but it would fail, since liquibase changed the command name in the past. We have enhanced the diffChangeLog (with capital L) command, so you have to run that.

Sometimes, Gradle cannot find a docker command to start the database instance to generate the changelog against. This happens due to some issue with setting the paths for Gradle daemon. Running the command without daemon fixes the issue:

./gradlew diffChangeLog --no-daemon

Static analysis

For the frontend, there are npm tasks prettier and eslint, which you should run before every commit. Otherwise, the "Frontend static check" workflow will fail. You can also use prettier plugins for VS Code, Idea, or WebStorm.

To fix prettier issues and check everything is fine, run these commands:

cd webapp
npm run prettier
npm run tsc
npm run eslint

On the backend, there is Gradle task ktlintFormat, which helps you to format Kotlin code.

./gradlew ktlintFormat