Build Steps

Local building and running the code

There are mainly two environments that we can build/run the code for: Development and Production

Building/running for development

• Ensure Database is running
• Run npm run dev

Building for Production

Inside the scripts folder the build.sh script can be found. There is also an outdated build.ps1 script for Windows.

This script creates a public folder with the code of the application, the installed plugins and other required scripts (ej: database-seed.sql).

Building for deployment

Running the scripts/build.sh script creates a public folder. Inside that folder is the code that needs to be deployed to any production environment. This public folder will contain the code for the backend application, the required configuration files, and various scripts used for updating the database.

It is also recommended to re-run the database-seed.sql (and load-data.sql if database is empty) using the runsql.sh script to ensure the database is updated with the latest changes if a new deploy is done.

Building/Running the Studio application

The command to run the Studio application is npm start.

To build studio for production the command is npm run build, but this is done automatically in the build.sh script.