Getting Started

To get started, there are 3 main steps:

  1. Cloning & building the application
  2. Configuring the application
  3. Configuration a web server

The process is outlined in detail below.

System Requirements


  1. Start by cloning this repository:
git clone
  1. cd into the root of the cloned repository. Then install the dependencies (these are installed locally):
./build setup setup-dev
  1. Build the client-side application:
# For development, run this:
./build client
# For production, run this:
NODE_ENV=production ./build client
# If you're actively working on the codebase and need to auto-recompile on every change, run this:
./build client-watch
  1. Change the ownership to allow your web server user to access the created directory. Usually, the web server will be running under the www-data user:
sudo chown -R www-data:www-data path/to/Air-Quality-Web
  1. Edit data/settings.toml to enter your database credentials.

You can edit other settings here too. See settings.default.toml for the settings you can change, but do not edit settings.default.toml! Edit data/settings.toml instead. You'll probably want to give the entire default settings file a careful read.

  1. Configure your web server to serve the root of the repository you've cloned if you haven't already. Skip this step if you cloned the repository into a directory that your web server already serves.
  1. Disallow public access to the private data directory.

In Nginx:

# Put this inside the "server {  }" website definition block:
# The "server {  }" block can usually be found somewhere in /etc/nginx on Linux machines, and may have a "server_name" directive specifying the domain name it's serving if multiple websites are configured.
location ^~ /path/to/data/directory {
    deny all;

In Apache:

# Create a file called ".htaccess" with this content inside the data/ directory
Require all denied
  1. Test the application with an API call. If this returns valid JSON, then you've set it up correctly
  1. (Optional) Setup HTTPS:
sudo apt install certbot
# On Nginx:
sudo certbot --nginx --domain
# On Apache:
sudo certbot --apache --domain