Contributing

First of all, thank you for showing interest in contributing to PlatySync!
All your contributions are extremely valuable to the project!

Get started

• Fork the repository, then clone or download your fork.
• Install dependencies with npm install in both the root directory and client directory.
• Serve the project with npm start
• Access locally using http://localhost:2328
• Build production versions with npm run build
• Test the project with npm test

npm scripts

All npm scripts are located at main package.json.

• npm start Starts the project. Runs client & server start npm scripts in parallel.
• npm run build Builds a release/compiled version of the project, available in /dist.
• npm run test Run project tests

Access

• Front-end client is served by vite on port 2328
• Back-end server is served by fastify on port 2327

Testing

This project uses the Vitest testing library.
Many of the tests rely on underlying assumptions, such as there being an existing user, schema, connector, rule, etc.
Due to the nature of how file-locking works and for the sake of speed, tests have been written to await completion of other tests.