Merge pull request #6 from graycraft/bugfix/2

Add proxy port, describe requirements and usage

Author: graycraft

.env.development

@@ -1,3 +1,6 @@
 HOSTNAME=localhost
 NODE_ENV=development
-PORT=3000
+NODE_NO_WARNINGS=1
+NODE_OPTIONS=--experimental-vm-modules
+PORT=8000
+PORT_PROXY=80

.env.production

@@ -1,3 +1,6 @@
 HOSTNAME=graycraft.me
 NODE_ENV=production
+NODE_NO_WARNINGS=1
+NODE_OPTIONS=--experimental-vm-modules
 PORT=4000
+PORT_PROXY=443

README.md

@@ -1,3 +1,84 @@
 # Graycraft
 
 Client and server logic of the [graycraft.me](https://graycraft.me) website.
+
+## Requirements
+
+Bash ^5.0.0:
+
+```bash
+$ bash --version
+  GNU bash, version 5.1.16(1)-release
+```
+
+Node.js 22.11.0:
+
+```bash
+$ node -v
+  v22.11.0
+```
+
+NPM 10.9.0:
+
+```bash
+$ npm -v
+  10.9.0
+```
+
+## Setup
+
+### Debian / Ubuntu
+
+```bash
+$ sudo apt-get install build-essential libcairo2-dev libgif-dev libjpeg-dev libpango1.0-dev librsvg2-dev
+```
+
+<https://www.npmjs.com/package/canvas>
+
+### Git
+
+Clone the Git repository:
+
+```bash
+$ git clone <gh|https|ssh>graycraft/me.git
+```
+
+### Node.js
+
+Use appropriate Node.js version:
+
+```bash
+$ nvm use
+```
+
+### NPM
+
+Install modules for usage:
+
+```bash
+$ npm i --production
+```
+
+Install modules for development:
+
+```bash
+$ npm i
+```
+
+### Environment
+
+Optionally `NODE_NO_WARNINGS` can be exported from `.env` file to silence process warnings regarding experimental features.
+
+This command also enables `--experimental-vm-modules` option for running [Jest with ESM](https://jestjs.io/docs/ecmascript-modules):
+
+```bash
+$ export $(cat .env.production | xargs)
+```
+
+## Usage
+
+Run production server script:
+
+```bash
+$ npm start
+```

app.mts

@@ -44,8 +44,8 @@ app.use('/', routerIndex);
  * Catch 404 and forward to error handler.
  */
 app.use(((req, res, next) => {
-  const { HOSTNAME, PORT } = process.env,
-    host = HOSTNAME + ':' + PORT,
+  const { HOSTNAME, PORT_PROXY } = process.env,
+    host = HOSTNAME + ':' + PORT_PROXY,
     cssBuffer = nodeFs.readFileSync('public/stylesheets/style.css'),
     css = String(cssBuffer),
     { color: colorQuery, size: sizeQuery } = req.query,

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "graycraft.me",
-  "version": "0.5.1-alpha",
+  "version": "0.5.2-alpha",
   "description": "Client and server logic of the graycraft.me website.",
   "main": "index.mts",
   "private": true,

package.json

@@ -17,8 +17,8 @@ import graycraft from '../source/graycraft.umd.js';
 
 const router = express.Router(),
   indexHandler: RequestHandler = (req, res) => {
-    const { HOSTNAME, PORT } = process.env,
-      host = HOSTNAME + ':' + PORT,
+    const { HOSTNAME, PORT_PROXY } = process.env,
+      host = HOSTNAME + ':' + PORT_PROXY,
       cssBuffer = nodeFs.readFileSync('public/stylesheets/style.css'),
       scriptBuffer = nodeFs.readFileSync('public/javascripts/graycraft.umd.js'),
       css = String(cssBuffer),