Skip to content

Latest commit

 

History

History
71 lines (54 loc) · 2.08 KB

README.md

File metadata and controls

71 lines (54 loc) · 2.08 KB
Raw

logo
SocketDB

Real-time synchronized data storage

Version Documentation License: MIT

· Homepage · Report Bug / Request Feature ·

Table of Contents

➡️ Documentation

You can find the documentation here: https://socketdb.com

Install

npm install -D @socketdb/client @socketdb/server

Run tests

pnpm run-many --target test

🤝 Contributing

Contributions, issues and feature requests are welcome!

  1. Check issues
  2. Fork the project
  3. Create your feature branch (git checkout -b feat/AmazingFeature)
  4. Test your changes pnpm run-many --target test
  5. Commit your changes (git commit -m 'feat: add amazingFeature')
  6. Push to the branch (git push origin feat/AmazingFeature)
  7. Open a pull request

Commit messages

This project uses semantic-release for automated release versions. So commits in this project follow the Conventional Commits guidelines. I recommend using commitizen for automated commit messages.

Show your support

Give a ⭐️ if this project helped you!

📝 License

This project is MIT licensed.