From 5ba1ca14642cc70b1392779b9d1016ce37140220 Mon Sep 17 00:00:00 2001 From: Nathan Byrd Date: Sun, 27 Aug 2023 12:25:36 -0500 Subject: [PATCH 1/6] Initial devcontainer setup --- .devcontainer/Dockerfile | 9 +++++++++ .devcontainer/devcontainer.json | 14 ++++++++++++++ .gitattributes | 10 ++++++++++ .gitignore | 3 +-- .vscode/launch.json | 17 +++++++++++++++++ 5 files changed, 51 insertions(+), 2 deletions(-) create mode 100644 .devcontainer/Dockerfile create mode 100644 .devcontainer/devcontainer.json create mode 100644 .vscode/launch.json diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile new file mode 100644 index 00000000..b095a6df --- /dev/null +++ b/.devcontainer/Dockerfile @@ -0,0 +1,9 @@ +FROM library/node:lts-bookworm + +ARG DEBIAN_FRONTEND=noninteractive +RUN apt update \ + && apt install -y --no-install-recommends sudo \ + && apt autoremove -y \ + && rm -rf /var/lib/apt/lists/* \ + && echo "node ALL=(ALL) NOPASSWD: ALL" >/etc/sudoers.d/node \ + && chmod 0440 /etc/sudoers.d/node diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json new file mode 100644 index 00000000..52828b2b --- /dev/null +++ b/.devcontainer/devcontainer.json @@ -0,0 +1,14 @@ +{ + "name": "Basic Node.js", + "build": { "dockerfile": "Dockerfile" }, +"remoteUser": "node", +"features": { + "ghcr.io/devcontainers/features/python:1": { + "installTools": true, + "version": "3.11" + }, + "ghcr.io/devcontainers-contrib/features/curl-apt-get:1": {}, + "ghcr.io/jungaretti/features/ripgrep:1": {}, + "ghcr.io/warrenbuckley/codespace-features/sqlite:1": {} +} +} diff --git a/.gitattributes b/.gitattributes index b1892ede..5463d1aa 100644 --- a/.gitattributes +++ b/.gitattributes @@ -6,3 +6,13 @@ *.TXT eol=crlf *.diz eol=crlf *.DIZ eol=crlf + +# Don't mess with shell script line endings +*.sh text eol=lf + +# Same thing for optutil.js which functions as a shell script +optutil.js text eol=lf + +# The devcontainer is also unix +.devcontainer/Dockerfile text eol=lf +.devcontainer/devcontainer.json text eol=lf \ No newline at end of file diff --git a/.gitignore b/.gitignore index b55cbcfa..2d3facac 100644 --- a/.gitignore +++ b/.gitignore @@ -10,5 +10,4 @@ logs/ mail/ node_modules/ docs/_site/ -docs/.sass-cache/ -.vscode/ +docs/.sass-cache/ \ No newline at end of file diff --git a/.vscode/launch.json b/.vscode/launch.json new file mode 100644 index 00000000..c52eeffb --- /dev/null +++ b/.vscode/launch.json @@ -0,0 +1,17 @@ +{ + // Use IntelliSense to learn about possible attributes. + // Hover to view descriptions of existing attributes. + // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387 + "version": "0.2.0", + "configurations": [ + { + "type": "node", + "request": "launch", + "name": "Launch Program", + "skipFiles": [ + "/**" + ], + "program": "${workspaceFolder}/main.js" + } + ] +} \ No newline at end of file From 8a6506c475cb62ed4ff4c88ad8d69418beaa0a3f Mon Sep 17 00:00:00 2001 From: Nathan Byrd Date: Sun, 27 Aug 2023 19:04:17 -0500 Subject: [PATCH 2/6] Additional changes needed to run --- .devcontainer/Dockerfile | 2 +- .devcontainer/devcontainer.json | 11 ++++++++--- .vscode/launch.json | 6 ++++++ .vscode/tasks.json | 25 +++++++++++++++++++++++++ docs/Gemfile | 1 + 5 files changed, 41 insertions(+), 4 deletions(-) create mode 100644 .vscode/tasks.json diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile index b095a6df..fcb42c10 100644 --- a/.devcontainer/Dockerfile +++ b/.devcontainer/Dockerfile @@ -2,7 +2,7 @@ FROM library/node:lts-bookworm ARG DEBIAN_FRONTEND=noninteractive RUN apt update \ - && apt install -y --no-install-recommends sudo \ + && apt install -y --no-install-recommends sudo telnet \ && apt autoremove -y \ && rm -rf /var/lib/apt/lists/* \ && echo "node ALL=(ALL) NOPASSWD: ALL" >/etc/sudoers.d/node \ diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json index 52828b2b..f6ab6d83 100644 --- a/.devcontainer/devcontainer.json +++ b/.devcontainer/devcontainer.json @@ -1,14 +1,19 @@ { "name": "Basic Node.js", "build": { "dockerfile": "Dockerfile" }, -"remoteUser": "node", +"remoteUser": "root", +"forwardPorts": [8888, 4000], +"postCreateCommand": "gem install jekyll bundler && /bin/rm -rf node_modules && npm install && cd docs && bundle install && cd ..", "features": { "ghcr.io/devcontainers/features/python:1": { "installTools": true, - "version": "3.11" + "version": "latest" }, "ghcr.io/devcontainers-contrib/features/curl-apt-get:1": {}, "ghcr.io/jungaretti/features/ripgrep:1": {}, - "ghcr.io/warrenbuckley/codespace-features/sqlite:1": {} + "ghcr.io/warrenbuckley/codespace-features/sqlite:1": {}, + "ghcr.io/devcontainers/features/ruby:1": { + "version": "3.1" + } } } diff --git a/.vscode/launch.json b/.vscode/launch.json index c52eeffb..9b1822fd 100644 --- a/.vscode/launch.json +++ b/.vscode/launch.json @@ -4,6 +4,12 @@ // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387 "version": "0.2.0", "configurations": [ + { + "name": "Browse local Documentation - Chrome", + "request": "attach", + "type": "chrome", + "url": "http://localhost:4000/enigma-bbs/" + }, { "type": "node", "request": "launch", diff --git a/.vscode/tasks.json b/.vscode/tasks.json new file mode 100644 index 00000000..c0880b20 --- /dev/null +++ b/.vscode/tasks.json @@ -0,0 +1,25 @@ +{ + "version": "2.0.0", + "tasks": [ + { + "label": "Start Jekyll (ENiGMA½ documentation server)", + "command": "cd docs && bundle exec jekyll serve", + "type": "shell" + }, + { + "label": "(re)build Jekyll bundles", + "command": "cd docs && bundle install", + "type": "shell" + }, + { + "label": "(re)build node modules", + "command": "/bin/rm -rf node_modules && npm install", + "type": "shell" + }, + { + "label": "ENiGMA½ new configuration", + "command": "./oputil.js config new", + "type": "shell" + } + ] +} \ No newline at end of file diff --git a/docs/Gemfile b/docs/Gemfile index ec96435d..ed87567f 100644 --- a/docs/Gemfile +++ b/docs/Gemfile @@ -30,3 +30,4 @@ end # Windows does not include zoneinfo files, so bundle the tzinfo-data gem gem "tzinfo-data", platforms: [:mingw, :mswin, :x64_mingw, :jruby] +gem "webrick" \ No newline at end of file From 5f0a03638e9195ea59830ac80e9cd04f8f0f97b7 Mon Sep 17 00:00:00 2001 From: Nathan Byrd Date: Mon, 28 Aug 2023 13:08:54 -0500 Subject: [PATCH 3/6] Added some handy extensions and tasks --- .devcontainer/devcontainer.json | 5 +++++ .vscode/tasks.json | 1 + 2 files changed, 6 insertions(+) diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json index f6ab6d83..57d83312 100644 --- a/.devcontainer/devcontainer.json +++ b/.devcontainer/devcontainer.json @@ -15,5 +15,10 @@ "ghcr.io/devcontainers/features/ruby:1": { "version": "3.1" } +}, +"customizations": { + "vscode": { + "extensions": ["ms-azuretools.vscode-docker","alexcvzz.vscode-sqlite","yzhang.markdown-all-in-one", "DavidAnson.vscode-markdownlint", "christian-kohler.npm-intellisense", "dbaeumer.vscode-eslint", "bierner.markdown-yaml-preamble"] + } } } diff --git a/.vscode/tasks.json b/.vscode/tasks.json index c0880b20..8f033263 100644 --- a/.vscode/tasks.json +++ b/.vscode/tasks.json @@ -4,6 +4,7 @@ { "label": "Start Jekyll (ENiGMA½ documentation server)", "command": "cd docs && bundle exec jekyll serve", + "isBackground": true, "type": "shell" }, { From 602d693cafc5a55c43fb0e19ba63110e17184ffa Mon Sep 17 00:00:00 2001 From: Nathan Byrd Date: Mon, 28 Aug 2023 13:10:38 -0500 Subject: [PATCH 4/6] Added additional local extensions --- .vscode/extensions.json | 6 ++++++ 1 file changed, 6 insertions(+) create mode 100644 .vscode/extensions.json diff --git a/.vscode/extensions.json b/.vscode/extensions.json new file mode 100644 index 00000000..bfd63065 --- /dev/null +++ b/.vscode/extensions.json @@ -0,0 +1,6 @@ +{ + "recommendations": [ + "ms-vscode-remote.remote-containers", + "laktak.hjson" + ] +} \ No newline at end of file From c2d7abc94e19ca48c90c42b8ea2e3da7dd51149d Mon Sep 17 00:00:00 2001 From: Nathan Byrd Date: Mon, 28 Aug 2023 14:17:47 -0500 Subject: [PATCH 5/6] Removed browse task as it won't run without debugging --- .vscode/launch.json | 6 ------ 1 file changed, 6 deletions(-) diff --git a/.vscode/launch.json b/.vscode/launch.json index 9b1822fd..c52eeffb 100644 --- a/.vscode/launch.json +++ b/.vscode/launch.json @@ -4,12 +4,6 @@ // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387 "version": "0.2.0", "configurations": [ - { - "name": "Browse local Documentation - Chrome", - "request": "attach", - "type": "chrome", - "url": "http://localhost:4000/enigma-bbs/" - }, { "type": "node", "request": "launch", From 1bd328452b86be7814eddbf667b9871e802f9981 Mon Sep 17 00:00:00 2001 From: Nathan Byrd Date: Mon, 28 Aug 2023 15:39:19 -0500 Subject: [PATCH 6/6] Added documentation for development setup --- docs/_config.yml | 1 + docs/_docs/installation/development.md | 38 ++++++++++++++++++++++++++ 2 files changed, 39 insertions(+) create mode 100644 docs/_docs/installation/development.md diff --git a/docs/_config.yml b/docs/_config.yml index 8520d124..34a77aa3 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -54,6 +54,7 @@ collections: - installation/network.md - installation/testing.md - installation/production.md + - installation/development.md - configuration/creating-config.md - configuration/sysop-setup.md - configuration/config-files.md diff --git a/docs/_docs/installation/development.md b/docs/_docs/installation/development.md new file mode 100644 index 00000000..ac27b528 --- /dev/null +++ b/docs/_docs/installation/development.md @@ -0,0 +1,38 @@ +--- +layout: page +title: Development Environment Setup +--- +_Note:_ This is only useful for people who are looking to contribute to the ENiGMA½ source base itself. Those that are just setting up a new BBS system do not need this section. + +The easiest way to get started with development on ENiGMA½ is via the pre-configured Visual Studio Code remote docker container environment. This setup will download and configure everything needed with minimal interaction. It also works cross-platform. + +* Install [Visual Studio Code](https://code.visualstudio.com/download) +* Install [Docker](https://docs.docker.com/engine/install/) +* Clone the [ENiGMA½](https://github.com/NuSkooler/enigma-bbs) repository. +* Choose "Open Folder" from Visual Studio Code and open the location where you cloned the repository. + +That's it! Visual Studio Code should prompt you for everything else that is needed, including some useful extensions for development. + +## Tasks + +Once it completes, there are a few tasks and run-configs that are useful. Open up the command pallete and search/choose "Tasks> Run Task". From there you can run the following tasks: + +### Start Jekyll (ENiGMA½ documentation server) + +This task will start the Jekyll server to perform local testing of changes to documentation. After running this task, open a browser to (http://localhost:4000/enigma-bbs/) to see the documentation. + +### (re)build Jekyll bundles + +When the image is created the Jekyll bundles are installed, so in general there shouldn't be much need to run this task. This is available however in case soemthing goes wrong or you are working on the Jekyll setup itself. + +### (re)build node modules + +Used to re-generate the node modules. Generally shouldn't be necessary unless something is broken or you are adding/changing versions of dependencies. + +### ENiGMA½ new configuration + +This task executes `oputil.js` in order to create a new BBS configuration (useful if you have just checked out the code and haven't setup any configuration yet.) + +## Run / Debug config + +There is also a default "Launch Program" config (hotkey access via F5 / Ctrl-Shift-D.) This will launch ENiGMA½. Once it has launched, access the system via telnet, port 8888 as usual. \ No newline at end of file