smswithoutborders / SMSWithoutBorders.com

Here is the interface through which users can manage their accounts and store their credentials
https://smswithoutborders.com
GNU General Public License v3.0
23 stars 8 forks source link

Modify Docs to prevent errors during windows project setup #65

Closed teyim closed 1 year ago

teyim commented 1 year ago

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: bandicam 2022-12-19 11-51-28-108

-Fix: prompt Windows users to switch to /use Command prompt or Git bash terminal

teyim commented 1 year ago

@nSedrickm i can open a PR for this

nSedrickm commented 1 year ago

Sure thing @teyim. We all work primarily with Linux. How do you plan on approaching this?

teyim commented 1 year ago

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.

I think just modifying the doc this way will help fix the current issues we have setting up the project on windows

nSedrickm commented 1 year ago

Good idea, we use bash and shell environments from dev to prod so modifying the script itself won't be ideal.

teyim commented 1 year ago

Yes.. I'll open a PR for this, in both this repo and the SMSWithoutBorders-Dev-FE repo.

teyim commented 1 year ago

@nSedrickm, please kinda review the PR I opened for this.

nSedrickm commented 1 year ago

Fixed in #66