intelsway / daydream

A small matrix web client written in rust

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
  • Built With
• Getting Started
  • Prerequisites
  • Setting up a Development Environment

• Roadmap
• Contributing
• License
• Contact
• Acknowledgements

About The Project

Built With

• Rust
• Matrix
• Yew
• Matrix Rust SDK
• Netlify
• Nodejs
• Yarn

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

git clone https://github.com/MTRNord/Daydream.git

2. Install node dependencies

yarn install

🛠️ Build

yarn run build

🔬 Serve locally

yarn run start:dev

Roadmap

See the open 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

MTRNord - @mtrnord - https://matrix.to/#/@mtrnord:nordgedanken.dev

Project Link: https://github.com/MTRNord/Daydream

Acknowledgements