https://github.com/rsamaium/signe
https://github.com/rsamaium/signe
Last synced: 6 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/rsamaium/signe
- Owner: RSamaium
- Created: 2024-06-04T08:31:01.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2024-10-18T07:58:25.000Z (8 months ago)
- Last Synced: 2024-11-08T11:50:31.174Z (7 months ago)
- Language: TypeScript
- Size: 231 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# 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. |
## Development
1. Ensure you have `pnpm` installed:
```bash
npm install -g pnpm
```
2. Clone the repository:
```bash
git clone https://github.com/RSamaium/signe
```
3. Install dependencies:
```bash
pnpm install
```
4. Start the development server:
```bash
pnpm run dev
```
## Deployment
1. Define a release:
```bash
pnpm run release
```
2. Push to the master branch for deployment on NPM:
```bash
git push origin master
```
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## Contributing
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests.
## Acknowledgments
- [PartyKit](https://partykit.dev)
- [Cloudflare](https://www.cloudflare.com)