https://github.com/basemax/liveblocks-javascript-authentication
A simple implementation of user authentication for Liveblocks using JavaScript. Liveblocks is a platform that enables real-time collaborative experiences in web applications. This example demonstrates how to authenticate users and manage access to rooms.
https://github.com/basemax/liveblocks-javascript-authentication
collaborative collaborative-development collaborative-editing collaborative-editor collaborative-framework collaborative-learning collaborative-research collaborative-writing javascript js liveblock liveblocks
Last synced: 9 months ago
JSON representation
A simple implementation of user authentication for Liveblocks using JavaScript. Liveblocks is a platform that enables real-time collaborative experiences in web applications. This example demonstrates how to authenticate users and manage access to rooms.
- Host: GitHub
- URL: https://github.com/basemax/liveblocks-javascript-authentication
- Owner: BaseMax
- License: gpl-3.0
- Created: 2024-09-24T15:00:30.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-23T09:30:13.000Z (11 months ago)
- Last Synced: 2025-03-28T17:08:07.626Z (9 months ago)
- Topics: collaborative, collaborative-development, collaborative-editing, collaborative-editor, collaborative-framework, collaborative-learning, collaborative-research, collaborative-writing, javascript, js, liveblock, liveblocks
- Language: JavaScript
- Homepage: https://liveblocks.io
- Size: 115 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Liveblocks JavaScript Authentication
This repository provides a simple implementation of user authentication for Liveblocks using JavaScript. Liveblocks is a platform that enables real-time collaborative experiences in web applications. This example demonstrates how to authenticate users and manage access to rooms.
https://liveblocks.io
## Features
- Generate unique user IDs for session management.
- Manage user access to different rooms based on organization and group.
- Simple integration with Liveblocks for real-time collaboration.
- Example frontend and backend implementation.
## Prerequisites
Before you begin, ensure you have met the following requirements:
- [Node.js](https://nodejs.org/) installed on your machine (version 14 or later).
- A Liveblocks account and a valid secret key.
## Installation
Clone the repository:
```bash
git clone https://github.com/BaseMax/liveblocks-javascript-authentication.git
cd liveblocks-javascript-authentication
```
Install the dependencies:
```bash
npm install
```
Start the backend server:
```bash
node auth.js
```
Run `npm run dev` and open the URL in the browser to see the frontend in action.
## Usage
Click the "Connect to Room" button in the frontend to initiate a connection to the Liveblocks room.
The backend will handle the authentication process and return the appropriate response to the frontend.
The frontend will update the status of connected users in real-time.
## Folder Structure
```
liveblocks-javascript-authentication/
├── .gitignore
├── auth.js # Backend authentication logic
├── index.html # Frontend HTML file
├── package.json # Node.js dependencies
├── package-lock.json # Lock file for package dependencies
├── README.md # Project documentation
└── room.js # Liveblocks client configuration
```
## API Endpoints
### `POST /api/liveblocks-auth`
Authenticates the user and authorizes access to a Liveblocks room.
Request Body:
```
{
"roomId": "string"
}
```
Response:
```
{
"token": "long string"
}
```
- **200 OK:** User is successfully authenticated.
- **400:** Authentication failed due to missing or invalid data.
## License
This project is licensed under the GPL-3.0 License.
## Contributing
Contributions are welcome! Please open an issue or submit a pull request to improve this project.
Copyright 2024, Max Base