Skip to content

Latest commit

 

History

History
65 lines (42 loc) · 1.96 KB

readme.md

File metadata and controls

65 lines (42 loc) · 1.96 KB

Signe

A collection of packages to manage real-time and reactive applications.

Packages

Package Description
@signe/reactive Primitive usage of reactivity with signal, computed, and effect.
@signe/sync Listens to signals within a class to synchronize with the client (if on the server-side) or, on the client-side, recreates a class from the data received from the server. Provides indication for data persistence.
@signe/room Creates a Room based on PartyKit for real-time applications. Can be deployed on Cloudflare.
@signe/di Dependency injection for Signe applications.

Development

  1. Ensure you have pnpm installed:

    npm install -g pnpm

  2. Clone the repository:

    git clone https://github.com/RSamaium/signe

  3. Install dependencies:

    pnpm install

  4. Start the development server:

    pnpm run dev

Deployment

  1. Define a release:

    pnpm run release

  2. Push to the master branch for deployment on NPM:

    git push origin master

License

This project is licensed under the MIT License - see the LICENSE file for details.

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests.

Acknowledgments