The easiest way to get started with Articulate is to use our included docker-compose file. Articulate relies on several services besides it’s own UI and API. These all get started when you use the provided compose.
Installing Prerequisites - Make sure you have Docker, Docker Compose, and Git installed:
Downloading - Download the current release from this page: https://github.com/samtecspg/articulate/releases/latest
Extracting - Unzip and get a terminal or command prompt in the new directory
Once you’ve got everything extracted you’re ready to start Articulate. The below instructions cover running locally and in the cloud:
This is the simplest setup and for most people wont required anything more than:
A few gotchas:
After Docker downloads the images and starts all of them Articulate should be available at http://localhost:3000 and the API documentation should be available at http://localhost:7500/documentation
The only extra requirement when running this way is an environment variable which informs the UI where to look for the API (the public url).
API_URL=http://xxx.xx.xx.xx:7500 docker-compose up