Trigger does not handle authentication of any kind. It is designed to be used behind a reverse proxy, such as NGINX, or other service that can request authentication prior to serving the page. An basic NGINX example file can be found in the root.

MariaDB/MySQL setup

Connect to your server:

sudo mariadb

Create the database and new administration user:

create database trigger_database;

grant all privileges on trigger_database.* TO 'triggeradmin'@'localhost' identified by 'trigger';

flush privileges;

⚠️ Update the above grant line to use a username and password other than the default. ⚠️

Import defaultDatabase.sql into your database server using your preferred management application or run the following via the terminal:

sudo mariadb -u triggeradmin -p trigger_database < defaultDatabase.sql

Configuration

Clone both the TriggerFrontend and TriggerBackend repositories. They do not need to be run from the same folder, or even the same machine.

Trigger uses .env files to configure the connection to the database as well as the base url for the application. Prior to running or building the app, you will need to edit the file at TriggerBackend/.env and TriggerFrontend/.env to match your environment.

Make a copy of the example file:

cp TriggerFrontend/.env.example TriggerFrontend/.env
cp TriggerBackend/.env.example TriggerBackend/.env

⚠️ Update the following fields to match your environment's URLs and credentials. The Domains and Base URL here must be defined without leading or trailing '/'! ⚠️

Frontend .env.example

VITE_DOMAIN_DEV='http://localhost:5000'
VITE_DOMAIN_PROD='https://domain.local'
VITE_BASE_URL='trigger'

Backend .env.example

DB_HOST='127.0.0.1'
DB_USER='triggeradmin'
DB_PASS='trigger'
DB_PORT='3306'
API_PORT='5000'
API_URI='trigger'

Run/build

To run the application without building:

npm run dev

To build the application for production:

npm run build

Run with pm2:

sudo npm install -g pm2

cd TriggerFrontend/
sudo pm2 serve ./dist --no-daemon --spa --port 3000

cd ..

cd TriggerBackend/
sudo pm2 start server.cjs

TODO

Mobile improvements
New Carosel on weather description
Updates to weather modal
Reivew Mantine v9 for changes