https://github.com/arnav-t/riot-embedded
Embedded version of Riot
https://github.com/arnav-t/riot-embedded
Last synced: about 1 month ago
JSON representation
Embedded version of Riot
- Host: GitHub
- URL: https://github.com/arnav-t/riot-embedded
- Owner: arnav-t
- Created: 2019-03-03T13:03:27.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-07T03:36:18.000Z (over 2 years ago)
- Last Synced: 2024-11-04T01:32:43.851Z (6 months ago)
- Language: JavaScript
- Size: 1.27 MB
- Stars: 62
- Watchers: 12
- Forks: 19
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-starred - arnav-t/riot-embedded - Embedded version of Riot (others)
README
# riot-embedded
Embedded version of Riot. Currently work in progress.
## Development workflow
### Installing dependencies
```
npm install
```
### Creating a bundle
#### For development:
```
npm run dev
```
#### For production:
```
npm run build
```
### Deploying to `webpack-dev-server` with hot reloading enabled (deployed on port 9000)
```
npm start
```
### Running the linter
```
npm run lint
```
### Configuration
Create `config.js` in the root directory of the repository with the following format.
```js
export let config = {
baseUrl: '',
roomId: '',
userId: '',
accessToken: ''
};
```
Leave out `userId` and `accessToken` to attempt registration as guest.
To set custom highlight colors, change the Sass variables `$color-highlight-custom` and `$color-txt-custom` in `styles/colors.scss` and set `highlight` to `'custom'` in the configuration.
#### Complete list of options:
* `baseUrl` (*string*) - Base URL of homeserver - **Required**
* `roomId` (*string*) - The internal ID of default room - **Required**
* `userId` (*string*) - The ID of default user
Ignore to register as guest
* `accessToken` (*string*) - Access token of default user
Ignore to register as guest
* `readOnly` (*boolean*) - If the client is in read-only mode
- `true`
- `false` (default)
Disables `msgComposer` and `roomsList` (unless overriden)
* `theme` (*string*) - Theme of the client
- `'dark'` - Dark theme (default)
- `'light'` - Light theme
- `'auto'` - Use device theme
* `highlight` (*string*) - Highlight color
- `'pink'` - Pink highlights (default)
- `'green'` - Green highlights
- `'custom'` - Custom highlight color
* `roomHeader` (*boolean*) - If room header should be displayed
- `true` (default)
- `false`
* `roomsList` (*boolean*) - If rooms list should be displayed (overrides `readOnly`)
- `true` (default)
- `false`
* `msgComposer` (*boolean*) - If message composer should be displayed (overrides `readOnly`)
- `true` (default)
- `false`
* `whitelist` (*Array*) - Whitelisted origins
Ignore to allow all origins
* `signInPrompt` (*string*) - Show sign in prompts
- `'none'` - Never show (default)
- `'guests'` - Show if signed in as guest
- `'all'` - Always show