Website powering the Alakajam! game making community
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
articles
assets
controllers
core
githooks
migrations
services
static
templates
tests
.browser-refresh
.browser-refresh-ignore
.editorconfig
.gitignore
CHANGES.md
LICENSE
README.md
config.sample.js
jsdoc.json
knexfile.js
package-lock.json
package.json
server.js
webpack.common.js
webpack.development.js
webpack.production.js

README.md

Initial setup

Requirement: NodeJS 7.6+

  • npm install --no-optional (*)
  • node server.js
  • Browse to http://localhost:8000

There is a default admin user (administrator/administrator).

For better performance, consider editing config.js to set up a PostgreSQL database.

(*) If npm install --no-optional failed to install sqlite3, retry with flag --build-from-source.

Developer tools

Prerequisites: npm install -g knex standard browser-refresh node-inspector jsdoc mocha

Recommended

  • browser-refresh server.js: Launches the app, and makes the server and browser refresh when needed upon file changes.
  • standard: Validates the code style. Run githooks/install.sh to trigger validation automatically before committing.

Other

  • node-debug server.js: Launches the app in debug mode.
  • npm run-script docs: Generates the JS documentation in the docs/ folder.
  • mocha tests/: Runs unit tests.
  • DEBUG=express:*: Enables debugging of routes and performance (must be set before launching the server).

See also the wiki for additional developer documentation.

How do I...

...Reset the data

  • With SQLite, all you have to do is delete the data/ folder.
  • PostgreSQL requires you additionally to empty your database.

...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.