From 10bfd71fa7dd8890ba21f70189951317efee948f Mon Sep 17 00:00:00 2001 From: "Zed A. Shaw" Date: Tue, 17 Jan 2023 05:24:19 +0400 Subject: [PATCH] Fix the instructions for the Linux users. --- rendered/docs/long-start.md | 2 +- rendered/docs/quick-start.md | 25 ++++++++++++++++++++++++- 2 files changed, 25 insertions(+), 2 deletions(-) diff --git a/rendered/docs/long-start.md b/rendered/docs/long-start.md index 9e4b4d3..9b32e86 100644 --- a/rendered/docs/long-start.md +++ b/rendered/docs/long-start.md @@ -90,7 +90,7 @@ You should have finished the [Quick Start](/client/#/quick/) so you have a worki Once you're sure everything is working you'll make a new page for the number guessing: ```shell -./bando.js djent --template ./static/djenterator/client.svelte --output client/pages/NumberGuess.svelte`. +./bando.js djent --template ./static/djenterator/client.svelte --output client/pages/NumberGuess.svelte ``` Then add it to the `client/routes.js` just like you did with `Test.svelte`. I'd put the page at `/number_guess/` to start, so in your browser you should be going to [http://127.0.0.1:5001/client/#/number/](http://127.0.0.1:5001/client/#/number/) to see the initial message. diff --git a/rendered/docs/quick-start.md b/rendered/docs/quick-start.md index 6e63bc9..082306c 100644 --- a/rendered/docs/quick-start.md +++ b/rendered/docs/quick-start.md @@ -94,6 +94,12 @@ node bando.js init This will configure some items, rerun the migrations just in case, and copy any template files that may have been missed. It will skip files you already have, and then wait for you to start the app in another window. +
+ +On some versions of Linux you may get a weird error Couldn't get a file descriptor referring to the console when the commands/init.js script tries to run Node's execSync. Currently I have no idea why this error happens, as it doesn't happen on any Linux I run. If you have an idea what's causing this, please let me know. If this happens + +
+ Open another Terminal window and start the app in `DANGER_ADMIN` mode: ```shell @@ -309,12 +315,29 @@ When you return to work on your project you'll first need to start up `redis` an node bando.js devsvc ``` -This should work on Linux, macOS, and Windows (with WSL+redis installed). Then you can start your project like normal: +This should work on macOS, and Windows (with WSL+redis installed). On Linux you should run `redis-server` using `systemctl` or whatever process manager you use. If you want to run it with `devsvc` then do this: + +```shell +node bando.js devsvc --os linux +``` + +Then you can start your project like normal: ```shell npm run DANGER_ADMIN ``` +## Try the Tests + +Finally, you should be able to run most of the tests in another terminal with this: + +```shell +# run this in another terminal +npm run test +``` + +You may get 1 failure due to DNS not working for the email testing, which you can ignore. You may get one more failure for an incorrect count on users, but run the tests again and it should run correctly. + ## Next Steps This Quick Start is designed to only get you up and running and make sure the basic features are working.