README.md

⚡ Prototype WebGL Application

A prototype of a WebGL application for a school project.

---

There is i18n support. Translations can be found in src/static/messages

npm scripts

Creating the database

First make sure that PostgreSQL is installed. I used version 10.0, but releases that are less recent should also work fine.

$ npm run db           # init the webgl_prototype database

Starting or building the server

Note that npm run dev hot reloads and renders universally.

$ npm run dev          # start the dev server
$ npm run prod:build   # build the prod server
$ npm run prod:start   # start the prod server

Environment variables

Make sure to create a .env file with the environment variables below, although APP_HTTPS can be left out. For more information, see the dotenv repository.

Option	Default
APP_HOST	localhost
APP_PORT	8080
APP_HTTPS	false
APP_SECRET	undefined
DB_USER	postgres
DB_PASS	undefined
DB_HOST	localhost
DB_PORT	5432
DB_NAME	webgl_prototype

Testing

$ npm test              # test code using Jest
$ npm run lint          # lint code using ESLint