[Docs]: Improvements for new contributors - Client/Server Setup - Users with Windows/WSL/Intellij

micarner commented 1 year ago

Is there an existing issue for this?

[X] I have searched the existing issues

Documentation Link

https://github.com/appsmithorg/appsmith/blob/release/contributions/ServerSetup.md, https://github.com/appsmithorg/appsmith/blob/release/contributions/ClientSetup.md

Discord/slack/intercom Link

No response

Describe the problem and improvement.

Having just recently set up a local dev environment, I ran into some issues (Windows 10, WSL, Intellij). In order to solve them I had to either google around or search the discord for previous answers. Having solved these, I'd like to add them to the documentation so that it can help any future fresh contributors.

I want to make changes to the following docs:

Mainly, it's these points here. I'll clean them up and fit them in the existing docs:

Add some verbiage to more easily direct those using windows/wsl to the appropriate sections
Run Config > Tick "do not build" This is enabled by default. You're already building it with the build command, don't do it again. It will probably error out anyways.
Run Config > Env Vars > Untick "include system environment variables" If you're on windows using WSL, this will include the windows paths which will immediately error out.
If the "environment variables" box isn't available, enable it with Run Config > Modify Options > Operating System > Environment Variables.
Then, click the box to open the environment variables box, and uncheck "include system environment variables"
Everything is running (client, server, mongo, redis, nginx) but I'm getting either "refused connection" OR site resolves with 503 application error nginx is already running, but you may need to restart it: sudo systemctl stop nginx sudo ./start-https.sh (NOT systemctl start nginx)
Refused to connect - Make sure you visit "http://dev.appsmith.com/" and not "http://dev.appsmith.com:3000/" even though that's what the server output tells you to use.

If you assign me this issue, I can get these added in.

danciaclara commented 1 year ago

@somangshu Passing this on to you for assigning it to the person who should take this ahead

micarner commented 1 year ago

You can assign this one to me. There are some other changes I need to add as well as outlined here: https://discord.com/channels/725602949748752515/1103430396940648508

micarner commented 1 year ago

@somangshu I created a PR for this issue: https://github.com/appsmithorg/appsmith/pull/23300

somangshu commented 1 year ago

Thanks @micarner, our moderators will review this and merge soon.
Thanks for the detailed contribution 🙏. I already see the value its adding for other community contributors. 🚀

jnikhila commented 6 months ago

@somangshu - Could you please evaluate and do the needful, if the issue is resolved, please close this issue.

somangshu commented 6 months ago

cc @riodeuno @KelvinOm

appsmithorg / appsmith-docs