Skip to content

Latest commit

 

History

History
85 lines (58 loc) · 2.52 KB

README.md

File metadata and controls

85 lines (58 loc) · 2.52 KB
Raw

BilboStack App

(a.k.a. Event Toolbox)

This software is intended to provide tools to event organizers. Including:

  • Talk listing
  • Talk details
  • Talk voting with comment
  • Talk question submission
  • Global voting summary for admins
  • (To Do) Single-talk voting summary for speakers

Requirements

  • Node
  • PostgreSQL
  • Redis

There is a docker-compose.yml file inside docker/eventtoolbox-devenv that you can use to start a development environment (PostgreSQL, Redis and Adminer) using Docker.

You can do this by running npm run devenv:up.

Development

Quickstart

npm install
npm run devenv:up
npm run migrate
npm start

And visit the application in localhost:8000.

Commands

These are the special commands that you will need to work with this.

Run them like npm run <command>.

  • test:docker: Will run the tests inside Docker (see Tests section).
  • devenv:up: Starts the development environment.
  • devenv:down: Stops the development environment.
  • migrate: Run migrations, updating the database schema.
  • lint: Run lint check.
  • lint:fix: Run lint check and fix the things that can be fixed automatically.

Tests

The tests are inside the test folder. Run them with the command npm test.

Tests can also run inside Docker. All the files involved in this process are inside docker/testing and you can run it by calling npm run test:docker or running run.sh inside docker/testing.

Running in production

You'll find a script inside scripts folder called deploy.sh. This will:

  • Build the Docker image locally.
  • Run the built Docker image with all the service dependencies.
  • Start listening on the specified PORT.
  • Run migrations against the PostgreSQL database.

For configuring this, you must create a .env file on the project's root folder like this:

POSTGRES_PASSWORD=verysecret
PORT=8080
BASE_URL=https://example.com
ADMIN_USER=admin
ADMIN_PASSWORD=password
  • POSTGRES_PASSWORD: The 'postgres' user in PostgreSQL database will take this password.
  • PORT: The server will run locally on this port.
  • BASE_URL: The server's url (including protocol, like https).
  • ADMIN_USER: Administrator user.
  • ADMIN_PASSWORD: Administrator password.

All this will create a data folder with the PostgreSQL persistent information.

Using a pre-compiled Docker image

Inside docker-compose.yml, in services.app, replace image: eventtoolbox with the name of the correct image (including registry url) and remove the build parameter.