https://github.com/beyondjs/backend
https://github.com/beyondjs/backend
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/beyondjs/backend
- Owner: beyondjs
- License: mit
- Created: 2022-09-19T16:05:20.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-12-13T21:01:45.000Z (over 1 year ago)
- Last Synced: 2025-03-24T17:49:20.482Z (about 1 year ago)
- Language: TypeScript
- Size: 34.2 KB
- Stars: 3
- Watchers: 4
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: license
Awesome Lists containing this project
README
# Welcome to `@beyond-js/backend` package
This package is a key component of BeyondJS and must be installed as a dependency to use Bridges in your project.
@beyond-js/backend provides a node-based backend service with Websocket connection and supports the execution of
Bridges, which allow you to create backend APIs with included data typing and corresponding client code to consume it.
Installation:
To install BeyondJS/Backend, run the following command in your terminal:
```
npm install @beyond-js/backend
```
### Config
You can set the next variables in your `.env` file.
- `MAX_ACTIVE_REQUEST`: [default: 60] Sets the maximum number of concurrent WebSocket connections that the library can handle, preventing overload and ensuring resource allocation efficienc
- `CACHE_EXPIRATION_TIME`: Allows you to set the duration of response caching, which improves performance by avoiding redundant calculations within the specified time frame. *Its value is represented in milliseconds*. By default it is set to 60000 (1 minute).
### Documentation:
For more information on using `@beyond-js/backend` and creating Bridges, see the full documentation at the following
link: [BeyondJS/ Backend docs](https://beyondjs.com/docs/backend/intro).
### License
MIT.