From b70cb924b78c5051cfe1ecfafd295982b1c746e6 Mon Sep 17 00:00:00 2001 From: bitfl0wer Date: Sun, 27 Aug 2023 17:04:25 +0200 Subject: [PATCH] Initial commit 3000 --- .rusty-hook.toml | 5 ++ Cargo.toml | 8 ++- README.md | 183 ----------------------------------------------- 3 files changed, 12 insertions(+), 184 deletions(-) create mode 100644 .rusty-hook.toml diff --git a/.rusty-hook.toml b/.rusty-hook.toml new file mode 100644 index 0000000..d6aea14 --- /dev/null +++ b/.rusty-hook.toml @@ -0,0 +1,5 @@ +[hooks] +pre-commit = "cargo fmt -p polyphony-native && exit 0" + +[logging] +verbose = true diff --git a/Cargo.toml b/Cargo.toml index 763bfc1..58a1670 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,8 +1,14 @@ [package] -name = "polyphony" +name = "polyphony-native" version = "0.1.0" edition = "2021" +license = "GPL-3.0" # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html [dependencies] +iced = "0.10" +chorus = { git = "https://github.com/polyphony-chat/chorus.git" } + +[dev-dependencies] +rusty-hook = "0.11.2" diff --git a/README.md b/README.md index 2fc72a3..34a072a 100644 --- a/README.md +++ b/README.md @@ -35,30 +35,6 @@

- -
- Table of Contents -
    -
  1. - About The Project - -
    2. -
  2. - Getting Started - -
    3. -
  3. Roadmap
    4. -
  4. Contributing
    5. -
  5. License
    6. -
  6. Contact
    7. -
  7. Acknowledgments
    8. -
-
- ## About The Project @@ -74,173 +50,14 @@ Ideally, you will be able to connect to multiple Spacebar instances at the same [Go read about the Spacebar project here!](https://github.com/spacebarchat) Spacebar describes itself as "_a free _open source _self hostable_ discord compatible_ chat, voice and video platform_". -

(back to top)

- -### Built With - -[![Svelte][svelte.dev]][svelte-url] -[![Rust]][rust-url] -[![Typescript]][typescript-url] - -

(back to top)

- - - -## Getting Started - -To set up a local development environment, follow these simple steps. -No matter which OS you are running, you will need to install `git` to follow these instructions. - -
- Linux - -### Prerequisites: Linux - -Install the rust toolchain and cargo. - -```bash -curl --proto '=https' --tlsv1.2 -sSf | sh -``` - -Install Node.js v19 and yarn - -Arch Linux: - -```bash -sudo pacman -S nodejs yarn -``` - -Debian/Ubuntu: - -```bash -curl -fsSL | sudo -E bash - -sudo apt-get install -y nodejs -sudo npm install -g yarn -``` - -
- -
- macOS - -### Prerequisites: macOS - -Install Homebrew, if you haven't already: - -```bash -/bin/bash -c $(curl -fsSL ) -``` - -Install the rust toolchain and cargo: - -```bash -brew install rustup-init -rustup-init -``` - -Install Node.js v19 and yarn: - -```bash -brew install node yarn -``` - -
- -
- Windows - -### Prerequisites: Windows - -Install the rust toolchain and cargo: - -1. Download and run the rustup-init.exe from -2. Follow the instructions to complete the installation. - -Install Node.js v19 and yarn: - -1. Download the installer from -2. Run the installer and follow the instructions to complete the installation. -3. Open a command prompt or PowerShell and run the following command to install yarn: - -```sh -npm install -g yarn -``` - -
- -Clone this project and install dependencies - -```sh -git clone https://github.com/polyphony-chat/polyphony.git -cd client -yarn install -``` - -You should now be able to run the client with `yarn tauri dev` from the project root. -You can independently build and run the Rust backend with `cargo run` from the `src-tauri` directory. - -

(back to top)

- -## Roadmap - -See the [open issues](https://github.com/polyphony-chat/polyphony/issues) for a full list of proposed features (and known issues). - -

(back to top)

- - - -## Contributing - -Read: [Polyphony Design and collaboration guidelines](https://github.com/polyphony-chat/polyphony/wiki/Design-Guidelines-for-collaborating-on-Polyphony) - -Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**. - -If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". -Don't forget to give the project a star! Thanks again! - -If you want to contribute code, please follow these steps: - -1. Find a [feature or issue you want to work on](https://github.com/polyphony-chat/polyphony/issues). If you want to work on something that is not listed, open an issue and we will discuss it. -2. Let it be known in the issue that you are working on it. This is to avoid duplicate work, especially since currently this project is still in its early stages and there are not many contributors. -3. Fork the Project -4. Create your Feature Branch (`git checkout -b feature/AmazingFeature`) -5. Commit your changes (`git commit -m 'Add some AmazingFeature'`) -6. Push to the Branch (`git push origin feature/AmazingFeature`) -7. Open a Pull Request - -

(back to top)

- - - -## License - -Distributed under the GPLv3 License. See `LICENSE.txt` for more information. - -

(back to top)

- - ## Contact florian@pro-weber.com -Project Link: [https://github.com/polyphony-chat/polyphony](https://github.com/polyphony-chat/polyphony) - -

(back to top)

- - - - - [build-shield]: https://img.shields.io/github/actions/workflow/status/polyphony-chat/polyphony/rust.yml?style=flat [build-url]: https://github.com/polyphony-chat/polyphony/blob/main/.github/workflows/rust.yml [contributors-shield]: https://img.shields.io/github/contributors/polyphony-chat/polyphony.svg?style=flat