https://github.com/yokyak/react-agent
Client and server-side state management library
https://github.com/yokyak/react-agent
database database-management javascript react reactjs redux sql state-management synchronization websockets
Last synced: 2 months ago
JSON representation
Client and server-side state management library
- Host: GitHub
- URL: https://github.com/yokyak/react-agent
- Owner: yokyak
- License: mit
- Created: 2018-01-06T00:57:49.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-11-05T22:05:23.000Z (over 6 years ago)
- Last Synced: 2025-04-02T08:55:51.700Z (2 months ago)
- Topics: database, database-management, javascript, react, reactjs, redux, sql, state-management, synchronization, websockets
- Language: JavaScript
- Homepage:
- Size: 2.11 MB
- Stars: 237
- Watchers: 7
- Forks: 21
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# React Agent
[](https://github.com/yokyak/react-agent/blob/master/LICENSE.txt)
[](https://www.npmjs.com/package/react-agent)
[](https://www.npmjs.com/package/react-agent-server)
[](https://travis-ci.org/yokyak/react-agent)
[](https://coveralls.io/github/yokyak/react-agent)
React Agent is a JavaScript library for your client store, server querying, and database management. It can be included in any React project without conflict with other state management tools or REST APIs.
React Agent is easy to learn.
Here's the basic idea: the client runs 'actions' that are defined on the server-side.
```javascript
// client.js
run(‘setMessage’, { message: ‘Hello World’ })
// server.js
setMessage: {
action: ‘INSERT INTO messages(text) VALUES(:message)’
}
```
These actions can be as powerful as you want -- i.e. CRUD operations, API calls, and authentication. Moreover, clients can subscribe to server-side actions so that they receive live updates.
React Agent includes offline-support to render optimistic updates and then synchronization on reestablished network connection. It also features time travel debugging.
*Why use React Agent?*
The popular conceptualization of state management stores state in two places: data on the client-side and data on the server-side.
To connect these, front-end and back-end developers usually write a lot of code such as HTTP requests, controllers, and routes. It can get complicated.
In contrast, React Agent serves as a communication channel between the client and the server. It abstracts state transfer to make it super easy to interact between the client and server.
## Documentation
Here's our full [API documentation](https://github.com/yokyak/react-agent/blob/master/docs/documentation.md).
## Getting Started
Install the package:
```bash
npm install react-agent --save
```
See [React Agent](https://github.com/yokyak/react-agent/tree/master/packages/react-agent) for information about client-side set-up.
Install the package:
```bash
npm install react-agent-server --save
```
See [React Agent Server](https://github.com/yokyak/react-agent/tree/master/packages/react-agent-server) for information about server-side set-up.
## Contributors
### Contributing
Please submit issues/pull requests if you have feedback or message the React Agent team to be added as a contributor: [email protected]
### Authors
* **Tom Rosenblatt** - [https://github.com/tskittles](https://github.com/tskittles)
* **Eric Choi** - [https://github.com/eric2turbo](https://github.com/eric2turbo)
* **Henry Au** - [https://github.com/hhau01](https://github.com/hhau01)
* **Andrew Harris** - [https://github.com/didrio](https://github.com/didrio)
## License
This project is licensed under the MIT License - see the [LICENSE.txt](LICENSE.txt) file for details