Brew o Matic

This project is an intent to rewrite BoM, the excellent web application for home brewers developed by Lautaro, using new technologies such as PWA and VueJS.

Requirements

You have to install nodejs and either npm or yarn. I recommend using nvm, which is a great node version manager.

Configuration

You need a config.js file in the backend root directory to run the application in development mode, this file has to have the environment specific information such as mongodb url or clientID/secret for the authentications methods that Bom supports.

If you run the application in production mode (for example with docker-compose, see below), you have to set the path to this file in the docker-compose.yml file:

  bom:
    .....
    volumes:
      - /tmp/dist/config.js:/usr/src/app/config.js

Development mode

Please move to the backend directory and execute

$ cd backend
$ yarn
$ yarn start

This will start the server (web services) application. Then, move to the frontend directory and run

$ cd frontend
$ yarn 
$ yarn dev

The system default browser should be opened and the web application displayed

Build

@TODO

Docker

If you have docker and docker-compose installed, I recommend that run the application with it:

1. First build the docker image

$ docker build -t brew-o-matic .

2. Then, start both containers (BoM and MongoDB)

$ docker-compose up