{ "componentChunkName": "component---src-templates-plugin-tsx", "path": "/plugins/scm-audit-log-plugin", "result": {"data":{"plugin":{"name":"scm-audit-log-plugin","displayName":"Audit Log","description":"Logs various actions on your server"},"readme":{"html":"

\n \n \"SCM-Manager\"\n \n

\n

\n Audit Log\n

\n

Logs various actions / changes on your server

\n

Usage

\n

Find out how this plugin works on the plugin documentation page.

\n

Build and testing

\n

The plugin can be compiled and packaged with the following tasks:

\n\n

For the development and testing the run task of the plugin can be used:

\n\n

If the plugin was started with gradle run, the default browser of the os should be automatically opened.\nIf the browser does not start automatically, start it manually and go to http://localhost:8081/scm.

\n

In this mode each change to web files (src/main/js or src/main/webapp), should trigger reload of the browser with the made changes.

\n

Directory & File structure

\n

A quick look at the files and directories you'll see in an SCM-Manager project.

\n
.\n├── node_modules/\n├── src/\n|   ├── main/\n|   |   ├── java/\n|   |   ├── js/\n|   |   └── resources/\n|   └── test/\n|       ├── java/\n|       └── resources/\n├── .editorconfig\n├── .gitignore\n├── build.gradle\n├── CHANGELOG.md\n├── gradle.properties\n├── gradlew\n├── LICENSE.txt\n├── package.json\n├── README.md\n├── settings.gradle\n├── tsconfig.json\n└── yarn.lock
\n
    \n
  1. \n

    node_modules/: This directory contains all modules of code that your project depends on (npm packages) are automatically installed.

    \n
    2. \n
  2. \n

    src/: This directory will contain all code related to what you see or not. src is a convention for “source code”.

    \n
      \n
    1. main/\n
        \n
      1. java/: This directory contains the Java code.
        2. \n
      2. js/: This directory contains the JavaScript code for the web ui, inclusive unit tests: suffixed with .test.ts
        3. \n
      3. resources/: This directory contains the classpath resources.
        4. \n
      \n
      2. \n
    2. test/\n
        \n
      1. java/: This directory contains the Java unit tests.
        2. \n
      2. resources/: This directory contains classpath resources for unit tests.
        3. \n
      \n
      3. \n
    \n
    3. \n
  3. \n

    .editorconfig: This is a configuration file for your editor using EditorConfig. The file specifies a style that IDEs use for code.

    \n
    4. \n
  4. \n

    .gitignore: This file tells git which files it should not track / not maintain a version history for.

    \n
    5. \n
  5. \n

    build.gradle: Gradle build configuration, which also includes things like metadata.

    \n
    6. \n
  6. \n

    CHANGELOG.md: All notable changes to this project will be documented in this file.

    \n
    7. \n
  7. \n

    gradle.properties: Defines the module version.

    \n
    8. \n
  8. \n

    gradlew: Bundled gradle wrapper if you don't have gradle installed.

    \n
    9. \n
  9. \n

    LICENSE.txt: This project is licensed under AGPLv3.

    \n
    10. \n
  10. \n

    package.json: Here you can find the dependency/build configuration and dependencies for the frontend.

    \n
    11. \n
  11. \n

    README.md: This file, containing useful reference information about the project.

    \n
    12. \n
  12. \n

    settings.gradle: Gradle settings configuration.

    \n
    13. \n
  13. \n

    tsconfig.json This is the typescript configuration file.

    \n
    14. \n
  14. \n

    yarn.lock: This is the ui dependency configuration.

    \n
    15. \n
\n

Need help?

\n

Looking for more guidance? Full documentation lives on our homepage or the dedicated pages for our plugins. Do you have further ideas or need support?

\n"}},"pageContext":{"name":"scm-audit-log-plugin"}}, "staticQueryHashes": ["1973669194","2742214048","2956773653"]}