Below are the steps to get started with Pulse as well as documentation for the various features of the framework.
Pulse is a lightweight server framework for Node.js. However, it isn't just a server framework, the primary focus of Pulse is reliability and validitity. Pulse works to create an ecosystem between the client and server that keeps clients up to date even when the server is under stress.
Pulse makes it easy to provide realtime data to clients while keeping them all in sync without all the traditional setup. With pulse it's as easy as initializing a Pulse router, connecting your Pulse clients and enabling the data properties you want pulse to keep up on.
Pulse takes a lot of inspiration from the GraphQL project as well as the Express.JS project. Pulse is designed to be a lightweight framework that can be used in conjunction with other frameworks or as a standalone framework.
Pulse would love to give a huge thanks to the open source packages that we rely on:
- bcryptjs
- body-parser
- cors
- jsonwebtoken
- log4js
- nedb
- toml
- uuid
- ws
- jest
- prettier
- react
- react-dom
- rimraf
- ts-jest
- ts-node
- tslint
- typescript
Pulse modules are separate NPM packages that are installed and used together in the Pulse ecosystem. The only optional package is pulse-cli which is more of a helper tool than a module.
Pulse Server is the server framework running both the HTTP server as well as the Pulse Socket (Websocket Connection) to the client.
Pulse Client is the client framework wrapping your React app making sure PulseDocs are sent and received correctly from the server.
Pulse CLI is the CLI tool that can be installed globally to help you work with the Pulse ecosystem. It is a very minimal package but with newer releases of pulse-server and pulse-client other helpful tools may be added.