README.md (5341B)
1 <!-- PROJECT SHIELDS --> 2 [](https://app.netlify.com/sites/daydream-rs/deploys) 3 [![Contributors][contributors-shield]][contributors-url] 4 [![Forks][forks-shield]][forks-url] 5 [![Stargazers][stars-shield]][stars-url] 6 [![Issues][issues-shield]][issues-url] 7 [![GPL-3.0 License][license-shield]][license-url] 8 [](https://matrix.to/#/#daydream:nordgedanken.dev) 9 10 11 12 <!-- PROJECT LOGO --> 13 <br /> 14 <p align="center"> 15 <a href="https://github.com/MTRNord/Daydream"> 16 <img src="" alt="Logo" width="80" height="80"> 17 </a> 18 19 <h3 align="center">Daydream Matrix Client</h3> 20 21 <p align="center"> 22 A small first try of writing a <a href="https://matrix.org">Matrix</a> Client in wasm and rust using the <a href="https://github.com/matrix-org/matrix-rust-sdk/">Matrix Rust SDK</a> 23 <!--<br /> 24 <a href="https://github.com/Nordgedanken/auto_hot_key_jetbrains_plugin"><strong>Explore the docs »</strong></a>--> 25 <br /> 26 <br /> 27 <!--<a href="https://plugins.jetbrains.com/plugin/13945-autohotkey-language">Get Plugin</a> 28 ·--> 29 <a href="https://github.com/MTRNord/Daydream/issues">Report Bug</a> 30 · 31 <a href="https://github.com/MTRNord/Daydream/issues">Request Feature</a> 32 </p> 33 </p> 34 35 36 37 <!-- TABLE OF CONTENTS --> 38 ## Table of Contents 39 40 * [About the Project](#about-the-project) 41 * [Built With](#built-with) 42 * [Getting Started](#getting-started) 43 * [Prerequisites](#prerequisites) 44 * [Setting up a Development Environment](#setting-up-a-development-environment) 45 <!--* [Usage](#usage)--> 46 * [Roadmap](#roadmap) 47 * [Contributing](#contributing) 48 * [License](#license) 49 * [Contact](#contact) 50 * [Acknowledgements](#acknowledgements) 51 52 53 54 <!-- ABOUT THE PROJECT --> 55 ## About The Project 56 57 <!--[![Plugin Screenshot][product-screenshot]](https://plugins.jetbrains.com/plugin/13945-autohotkey-language)--> 58 59 60 ### Built With 61 62 * [Rust](https://www.rust-lang.org/) 63 * [Matrix](https://matrix.org) 64 * [Yew](https://github.com/yewstack/yew) 65 * [Matrix Rust SDK](https://github.com/matrix-org/matrix-rust-sdk/) 66 * [Netlify](https://netlify.com) 67 * [Nodejs](https://nodejs.org/en/) 68 * [Yarn](https://yarnpkg.com/) 69 70 71 72 <!-- GETTING STARTED --> 73 ## Getting Started 74 75 To get a local copy up and running follow these simple steps. 76 77 ### Prerequisites 78 79 This is an example of how to list things you need to use the software and how to install them. 80 * Rust 81 * Nodejs 82 * Yarn 83 * gettext (See: https://github.com/kellpossible/cargo-i18n#system-requirements) 84 * When you want to recompile translations: 85 * https://github.com/kellpossible/cargo-i18n 86 * `cargo install xtr` 87 88 ### Setting up a Development Environment 89 90 1. Clone the repo 91 ```sh 92 git clone https://github.com/MTRNord/Daydream.git 93 ``` 94 2. Install node dependencies 95 ```sh 96 yarn install 97 ``` 98 99 #### 🛠️ Build 100 101 ```sh 102 yarn run build 103 ``` 104 105 #### 🔬 Serve locally 106 107 ```sh 108 yarn run start:dev 109 ``` 110 111 <!-- USAGE EXAMPLES 112 ## Usage 113 114 Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources. 115 116 _For more examples, please refer to the [Documentation](https://example.com)_ 117 118 --> 119 120 <!-- ROADMAP --> 121 ## Roadmap 122 123 See the [open issues](https://github.com/MTRNord/Daydream/issues) for a list of proposed features (and known issues). 124 125 126 127 <!-- CONTRIBUTING --> 128 ## Contributing 129 130 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**. 131 132 1. Fork the Project 133 2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`) 134 3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`) 135 4. Push to the Branch (`git push origin feature/AmazingFeature`) 136 5. Open a Pull Request 137 138 139 140 <!-- LICENSE --> 141 ## License 142 143 Distributed under the AGPL-v3.0 License. See `LICENSE` for more information. 144 145 146 147 <!-- CONTACT --> 148 ## Contact 149 150 Matrix Room - [#daydream:nordgedanken.dev](https://matrix.to/#/#daydream:nordgedanken.dev) 151 152 MTRNord - [@mtrnord](https://github.com/mtrnord) - https://matrix.to/#/@mtrnord:nordgedanken.dev 153 154 Project Link: [https://github.com/MTRNord/Daydream](https://github.com/MTRNord/Daydream) 155 156 157 158 <!-- ACKNOWLEDGEMENTS --> 159 ## Acknowledgements 160 161 162 163 164 165 <!-- MARKDOWN LINKS & IMAGES --> 166 <!-- https://www.markdownguide.org/basic-syntax/#reference-style-links --> 167 [contributors-shield]: https://img.shields.io/github/contributors/MTRNord/Daydream.svg?style=flat-square 168 [contributors-url]: https://github.com/MTRNord/Daydream/graphs/contributors 169 [forks-shield]: https://img.shields.io/github/forks/MTRNord/Daydream.svg?style=flat-square 170 [forks-url]: https://github.com/MTRNord/Daydream/network/members 171 [stars-shield]: https://img.shields.io/github/stars/MTRNord/Daydream.svg?style=flat-square 172 [stars-url]: https://github.com/MTRNord/Daydream/stargazers 173 [issues-shield]: https://img.shields.io/github/issues/MTRNord/Daydream.svg?style=flat-square 174 [issues-url]: https://github.com/MTRNord/Daydream/issues 175 [license-shield]: https://img.shields.io/github/license/MTRNord/Daydream.svg?style=flat-square 176 [license-url]: https://github.com/MTRNord/Daydream/blob/master/LICENSE 177 [product-screenshot]: images/screenshot.png