Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/timobechtel/socketdb
Real-time data synchronization
https://github.com/timobechtel/socketdb
database db javascript nodejs real-time socket socket-io socketdb synchronization websocket
Last synced: 3 months ago
JSON representation
Real-time data synchronization
- Host: GitHub
- URL: https://github.com/timobechtel/socketdb
- Owner: TimoBechtel
- License: mit
- Created: 2020-11-19T11:50:15.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-11-01T00:15:07.000Z (3 months ago)
- Last Synced: 2024-11-01T01:19:03.011Z (3 months ago)
- Topics: database, db, javascript, nodejs, real-time, socket, socket-io, socketdb, synchronization, websocket
- Language: TypeScript
- Homepage: https://socketdb.com
- Size: 1.91 MB
- Stars: 5
- Watchers: 3
- Forks: 0
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
SocketDB
Real-time synchronized data storage
·
Homepage
·
Report Bug / Request Feature
·
## Table of Contents
- [Installation](#install)
- [Test](#run-tests)
- [Contributing](#Contributing)
- [License](#license)
## ➡️ Documentation
You can find the documentation here:
## Install
```sh
npm install -D @socketdb/client @socketdb/server
```
## Run tests
```sh
pnpm run-many --target test
```
## 🤝 Contributing
Contributions, issues and feature requests are welcome!
1. Check [issues](https://github.com/TimoBechtel/socketdb/issues)
1. Fork the project
1. Create your feature branch (`git checkout -b feat/AmazingFeature`)
1. Test your changes `pnpm run-many --target test`
1. Commit your changes (`git commit -m 'feat: add amazingFeature'`)
1. Push to the branch (`git push origin feat/AmazingFeature`)
1. Open a pull request
### Commit messages
This project uses semantic-release for automated release versions. So commits in this project follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0-beta.2/) guidelines. I recommend using [commitizen](https://github.com/commitizen/cz-cli) for automated commit messages.
## Show your support
Give a ⭐️ if this project helped you!
## 📝 License
This project is [MIT](https://github.com/TimoBechtel/socketdb/blob/main/LICENSE) licensed.