From f1b24c0737daa3b6b4af6306bcf8104d1f9f4038 Mon Sep 17 00:00:00 2001 From: Arpit Mohan Date: Wed, 3 Mar 2021 13:53:05 +0530 Subject: [PATCH] Improving the IntelliJ IDE setup steps --- contributions/ServerSetup.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/contributions/ServerSetup.md b/contributions/ServerSetup.md index 69d117a400..cd1f87187f 100644 --- a/contributions/ServerSetup.md +++ b/contributions/ServerSetup.md @@ -93,11 +93,22 @@ When using this command, the value of `APPSMITH_REDIS_URI` should be set to `red To run the project from within the IDE, you will need to make use of the run configuration that is part of the repository. The run configuration uses the [EnvFile](https://plugins.jetbrains.com/plugin/7861-envfile) plugin to include environment variables in the path. Any and all tests can be run within the IDE by cloning this run configuration. +1. Install the plugin EnvFile from https://plugins.jetbrains.com/plugin/7861-envfile. This is required to load the environment configurations when the server starts. +2. Configure the Run/Debug configuration as shown in the screenshot below: +Screenshot 2021-03-03 at 1 50 48 PM + +For being able to run or debug plugins, two are especially important: + +- VM Options: `-Dpf4j.mode=development -Dpf4j.pluginsDir=appsmith-plugins` . +- Working Directory: The folder that contains `appsmith-server`, `appsmith-plugins` etc. + Please note when setting **Working directory** option. If the path is not correct, plugins will fail to load and cannot fetch data from mongo, redis example: -![381611580157_ pic_hd](https://user-images.githubusercontent.com/4025839/105710505-2ead5300-5f52-11eb-9549-531e459e86ea.jpg) +3. Load your env file by going to the EnvFile Tab in the Run/Debug configuration settings for your server. +Screenshot 2021-03-03 at 1 49 17 PM + ## Need Assistance - If you are unable to resolve any issue while doing the setup, please feel free to ask questions on our [Discord channel](https://discord.com/invite/rBTTVJp) or initiate a [Github discussion](https://github.com/appsmithorg/appsmith/discussions) or send an email to `support@appsmith.com`. We'll be happy to help you.