Getting started
PlatySync is a free, open source application that helps automate workflows which take input data such as CSV files and perform conditional actions based on the data of each row. For more information, see About PlatySync.
This guide assumes you want install the user version of the application, and not the developer version.
If you wish to contribute to the project then check out this page.
Note: this project has not been tested in a Linux or Mac environment, only Windows.
If you encounter any bugs, please submit them as an issue.
If you do not already have a node environment configured, head over to download page and install the latest version (including npm).
PlatySync was developed on node version 18.18.0 but has been tested on v20 and will likely work on newer versions.
Download the most recent version of PlatySync from the releases page.
Extract the archive whereever you would like PlatySync to be installed and run:
$ npm installThen, if you would like to install the app as a windows service, run npm run service-install
The Windows service installs via WinSW and can be customised via service.xml as required.
If you want to serve the application and access it from another device, then you will likely need to allow port 2327 through your firewall.
If you installed as a windows service, start the service via windows services mmc, or run npm run service-start.
Otherwise standard node environment rules apply. Run:
$ npm start
or
$ node server.jsIn your preferred web-browser, navigate to http://localhost:2327 (replacing localhost with the IP of the host if accessing remotely).
You will be presented with the first run page used to configure the administrator account:
Configure the username and password for the initial administrator / default account to login. You can add more users later.
The PlatySync application is now configured and ready for use. General application settings can be found on the settings tab.
Next up, learn how to create an application schema.