Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/daydream-mx/Daydream
A small matrix web client written in rust
https://github.com/daydream-mx/Daydream
client matrix matrix-org rust wasm webapp webassembly yew
Last synced: 3 days ago
JSON representation
A small matrix web client written in rust
- Host: GitHub
- URL: https://github.com/daydream-mx/Daydream
- Owner: daydream-mx
- License: agpl-3.0
- Archived: true
- Created: 2020-05-25T14:26:57.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2020-12-13T03:03:09.000Z (almost 4 years ago)
- Last Synced: 2024-08-02T12:49:33.644Z (3 months ago)
- Topics: client, matrix, matrix-org, rust, wasm, webapp, webassembly, yew
- Language: Rust
- Homepage: https://daydream.im/
- Size: 8.99 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://app.netlify.com/sites/daydream-rs/deploys)
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![GPL-3.0 License][license-shield]][license-url]
[](https://matrix.to/#/#daydream:nordgedanken.dev)
![Logo]()
Daydream Matrix Client
A small first try of writing a Matrix Client in wasm and rust using the Matrix Rust SDK
Report Bug
·
Request Feature
## Table of Contents
* [About the Project](#about-the-project)
* [Built With](#built-with)
* [Getting Started](#getting-started)
* [Prerequisites](#prerequisites)
* [Setting up a Development Environment](#setting-up-a-development-environment)
* [Roadmap](#roadmap)
* [Contributing](#contributing)
* [License](#license)
* [Contact](#contact)
* [Acknowledgements](#acknowledgements)
## About The Project
### Built With
* [Rust](https://www.rust-lang.org/)
* [Matrix](https://matrix.org)
* [Yew](https://github.com/yewstack/yew)
* [Matrix Rust SDK](https://github.com/matrix-org/matrix-rust-sdk/)
* [Netlify](https://netlify.com)
* [Nodejs](https://nodejs.org/en/)
* [Yarn](https://yarnpkg.com/)
## Getting Started
To get a local copy up and running follow these simple steps.
### Prerequisites
This is an example of how to list things you need to use the software and how to install them.
* Rust
* Nodejs
* Yarn
* gettext (See: https://github.com/kellpossible/cargo-i18n#system-requirements)
* When you want to recompile translations:
* https://github.com/kellpossible/cargo-i18n
* `cargo install xtr`
### Setting up a Development Environment
1. Clone the repo
```sh
git clone https://github.com/MTRNord/Daydream.git
```
2. Install node dependencies
```sh
yarn install
```
#### 🛠️ Build
```sh
yarn run build
```
#### 🔬 Serve locally
```sh
yarn run start:dev
```
## Roadmap
See the [open issues](https://github.com/MTRNord/Daydream/issues) for a list of proposed features (and known issues).
## Contributing
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
## License
Distributed under the AGPL-v3.0 License. See `LICENSE` for more information.
## Contact
Matrix Room - [#daydream:nordgedanken.dev](https://matrix.to/#/#daydream:nordgedanken.dev)
MTRNord - [@mtrnord](https://github.com/mtrnord) - https://matrix.to/#/@mtrnord:nordgedanken.dev
Project Link: [https://github.com/MTRNord/Daydream](https://github.com/MTRNord/Daydream)
## Acknowledgements
[contributors-shield]: https://img.shields.io/github/contributors/MTRNord/Daydream.svg?style=flat-square
[contributors-url]: https://github.com/MTRNord/Daydream/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/MTRNord/Daydream.svg?style=flat-square
[forks-url]: https://github.com/MTRNord/Daydream/network/members
[stars-shield]: https://img.shields.io/github/stars/MTRNord/Daydream.svg?style=flat-square
[stars-url]: https://github.com/MTRNord/Daydream/stargazers
[issues-shield]: https://img.shields.io/github/issues/MTRNord/Daydream.svg?style=flat-square
[issues-url]: https://github.com/MTRNord/Daydream/issues
[license-shield]: https://img.shields.io/github/license/MTRNord/Daydream.svg?style=flat-square
[license-url]: https://github.com/MTRNord/Daydream/blob/master/LICENSE
[product-screenshot]: images/screenshot.png