Skip to main content

Core

GitHub Repo: https://github.com/CrossCopy/crosscopy-core

The core package has multiple components

  • Encryption
  • Plugin System
  • Sqlite Database Definition for Client
  • SocketIO Service
  • Common Utilities
    • JWT

Environment Setup

git clone [email protected]:CrossCopy/crosscopy-core.git
cd crosscopy-core
npm install # Install dependencies
npm run test # Run tests with jest
npm run build # build package with tsup

CICD

GitHub Workflows

WorkflowAction URLWorkflow File
Unittestunittest.ymlunittest.yml
Publish Packagerelease-package.ymlrelease-package.yml

CI (Unittest)

Triggered on all push and pull requests.

CD (Publish)

Workflow triggered when

  • release created
  • push to release/* branch
  • push to tag v*

Don't forget to update version in package.json.

Publish Package

The CD workflow is the recommended way to publish a package.

You can also publish a package manually by running npm publish.