Initial setup
Requirement: NodeJS 10+
npm install --no-optional
npm start
- Browse to
http://localhost:8000
- You can login as
administrator
/administrator
Tips:
- If npm fails to install
sqlite3
on Windows, runnpm i -g --production windows-build-tools
and retry. You may need to upgrade NodeJS to a recent version. - For better performance, consider editing
config.js
to set up a PostgreSQL database.
See the wiki for additional documentation.
How do I...
...Debug the server with VSCode
Put this in .vscode/launch.json
:
{
"version": "0.2.0",
"configurations": [
{
"name": "Debug Alakajam!",
"type": "node",
"request": "launch",
"args": ["${workspaceFolder}\\server\\index.ts"],
"runtimeArgs": ["--nolazy", "-r", "ts-node/register/transpile-only", "-r", "tsconfig-paths/register"],
"sourceMaps": true,
"cwd": "${workspaceRoot}",
"protocol": "inspector",
"outputCapture": "std"
}
]
}
...Reset the data
- Stop the server and delete the
data/
folder. - If using PostgreSQL, also empty your database (example:
drop schema public cascade; create schema public;
).
...Enable picture resizing
Run npm install
without the --no-optional
flag to try and set up the sharp
dependency. If it fails to install (especially on Windows), follow the instructions to install the sharp dependencies, then try npm install
again.
...Run only one unit test
Run only partial tests by appending the required file as an argument. For instance:
npm run test:unit -- user.service