Modify Docs to prevent errors during windows project setup
Closed this issue · 7 comments
Users will encounter several issues while setting up this project on windows
issue 1
Windows users will get a make not recognized as an internal or external command when trying to run the app locally after installing dependencies..
-Fix : Doc should prompt windows users ( with necessary commands) to install make via Chocolatey
issue 2
On Windows, an IDE like VS CODE uses PowerShell as the default terminal, which will give the following error when the prestart script runs:
-Fix: prompt Windows users to switch to /use Command prompt or Git bash terminal
@nSedrickm i can open a PR for this
Sure thing @teyim. We all work primarily with Linux. How do you plan on approaching this?
I use windows, and I think future contributors will. So I think the easiest way of fixing this will just be to modify the Setup guide doc, adding a section for windows users only, just before the Start development server step.
- show command to install Chocolatey and make on windows
- prompt users to use either Windows command prompt or Git bash terminal for development
I think just modifying the doc this way will help fix the current issues we have setting up the project on windows
Good idea, we use bash and shell environments from dev to prod so modifying the script itself won't be ideal.
Yes.. I'll open a PR for this, in both this repo and the SMSWithoutBorders-Dev-FE repo.
@nSedrickm, please kinda review the PR I opened for this.