This is Strautomator's web frontend, built with NuxtJS + Vuetify. It depends on the Strautomator Core to run. Please make sure you read the docs for the Core first before proceeding with the Web setup.
Strautomator is using the SetMeUp module to handle its settings, so for detailed info please check its docs. The settings are split as follows:
- settings.json - settings shared by all environments, targeting production by default
- settings.development.json - development settings, mostly when running on your dev machine
- settings.production.json - production-only settings, except credentials and secrets (optional)
- settings.secret.json - private credentials and secrets, excluded from the GIT repo
- settings.local.json - private local-only settings, excluded from the GIT repo
Please note that the Core also has its own collection of settings files as well. If the same setting is define on the Core and on the Web, the Web settings has the higher priority.
Before you try to get an instance running locally, make sure you have followed the Getting started instructions to have all the required 3rd party dependencies ready.
First, create a folder on your machine that will server as the root all the Strautomator related components. Then proceed to clone this and the core repo and install all the necessary dependencies:
$ mkdir ~/strautomator
$ cd ~/strautomator
$ git clone git@github.com:strautomator/web.git
$ git clone git@github.com:strautomator/core.git
$ cd core
$ make update
$ cd ../
$ cd web
$ make update
Make a copy of the settings.secret.json.sample and name it settings.secret.json. This is where you'll store all the credentials and sensitive keys. This file is encrypted automatically whenever the application starts up. You can also encrypt and decrypt on demand by using the $ make encrypt and $ make decrypt commands.
For other non-sensitive data, you can create a settings.local.json. This file is kept in clear text on your local machine.
The default URL in development is http://localhost:3000, which should be manually set on your HOSTS file. This is fine if you only want to work on the web frontend and some of the API calls, but please note that Strava (and other 3rd party webhooks) won't be able to push data to the service using that URL. Authentication with Strava might also fail.
To properly test all APIs and webhooks from Strava and PayPal, you'll need to change the app.url setting on your settings.local.json file or preferably via the $SMU_app_url environment variable, to a publicly accessible URL. It's recommended to use a tunnel to avoid port forwarding on your router.
If for whatever reason you want to split the Strautomator API from the frontend, you can use the api.url setting to specify the base path for the API. By default, it runs on the /api/ path under the same URL set on the app.url.
If you plan to deploy the instance to production and build the nuxt app beforehand, it's mandatory to set the app URL via the environment variable $SMU_app_url.
The easiest way to get the web frontend running and accessible with SSL is by using a tunnel. By default the app will try opening a tunnel with Cloudflare when running on dev, but you'll need to setup the tunnel manually first. Instructions can be found here.
To disable the tunnel execution, set the app.tunnel setting to false on the settings.local.json file.
When starting up, the service will look for the strautomator.cert and strautomator.key files on the application root. If found, it will create a HTTPS server with those certificate files, otherwise it will create a regular HTTP server. The default ports:
- Development: 3000
- Production (HTTP): 8080
- Production (HTTPS): 8443
Please note that the actual port can be overwritten either via the PORT environment variable, or via settings.app.port setting.
As simple as:
$ make run
If any required settings are missing or wrongly set, you'll get alerted on the console. When running locally (NODE_ENV is development), all features dependent on scheduled functions will run at startup.
Strautomator is targeting GCP and can be easily deployed as a standalone VM instance, as a Cloud Run service, or to App Engine. Although you could also run it on other providers (AWS for instance), please keep in mind that the database, Cloud Firestore, runs on Google.
Also note that even thou this project is open source, you might need to adapt some settings if you want to run it in production on your own cloud environment. This includes changing the target URL (https://strautomator.com/), server IP and ports, HTMLs with references to strautomator.com, etc.
Basic deployment samples are provided:
- App Engine: app.yaml (not tested in production).
- VM in Google Cloud Compute: docker-compose.yml (not tested in production).
- Cloud Run: create a Cloud Build trigger to update your service whenever there's a new version pushed to your GIT fork.
Please note that some features depend on scheduled functions to work. These can be found here, and need to be deployed separately to your environment of choice.