README.md

Action Automation

❓ PlatySync

PlatySync is an application which takes data input, such as a CSV file, and execute actions based on conditions.

💪 Features

Some of the features PlatySync provides are:

• 💉 CSV to LDAP: Automate the management of your user directory based on a CSV source-of-truth
• 🤗 Onboarding: Automate onboarding of new users by generating (and printing) PDF docs from a template
• 📂 Bulk Actions: Perform bulk operations, such as renaming all files in a folder using a naming convention
• 🛠️ Template System: Build automation rules uses a powerful string template system with a scope explorer
• ⏰ Schedules: Execute automation rules on a CRON schedule or by monitoring a specific file

🔽 Download

You can download the most recent version of PlatySync from GitHub releases.
Learn how to use PlatySync by following the documentation.

🚀 Install and run

1. Ensure you are running Node.js v18.18.0 or higher.
2. Download the most recent version of PlatySync from the releases page.
3. Extract and install dependencies with npm install
4. Start the software with with npm start
   For additional instructions, refer to the documentation.

📚 Everything else

📙 Contributing

Thank you for considering contributing to PlatySync.
You can find a contribution guide in the wiki.

🛠️ Building

To build PlatySync, you can follow the documentation.

📦 npm scripts

• npm install Installs dependencies.
• npm start Starts PlatySync.
• npm run service-install Install as a windows service.
• npm run service-start Start windows service.
• npm run service-stop Stop windows service.
• npm run service-uninstall Uninstall windows service.
• npm run upgrade Run after after updating version.

📄 Documentation

You can find the documentation for PlatySync here.