Skip to content

Commit

Permalink
replace cargo and readme files
Browse files Browse the repository at this point in the history
  • Loading branch information
bitfl0wer committed Dec 12, 2023
1 parent f3df47a commit 228c25e
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 69 deletions.
29 changes: 8 additions & 21 deletions Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,22 +1,9 @@
[package]
name = "polyphony-native"
version = "0.1.0"
edition = "2021"
license = "GPL-3.0"
[workspace]
members = ["crates/polyphony-wasm", "crates/polyphony-tauri"]
resolver = "2"

# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

[dependencies]
iced = { version = "0.10", features = ["tokio"] }
chorus = { path = "../chorus", features = ["client"] }
tokio = { version = "1.32.0", features = ["rt-multi-thread"] }
serde = { version = "1.0.188", features = ["derive", "rc"] }
serde_json = "1.0.105"
log = "0.4.20"
async-trait = "0.1.73"
env_logger = "0.10.0"

[dev-dependencies]
rusty-hook = "0.11.2"
iced = { version = "0.10", features = ["debug"] }
tokio = { version = "1.32.0", features = ["full"] }
[profile.release]
opt-level = 'z'
lto = true
codegen-units = 1
panic = "abort"
83 changes: 35 additions & 48 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,79 +1,66 @@
<a name="readme-top"></a>

<div align="center">

[![Discord]][Discord-invite]
[![Build][build-shield]][build-url]
[![Contributors][contributors-shield]][contributors-url]
[![Issues][issues-shield]][issues-url]
<img src="https://img.shields.io/badge/0.10-blue?logo=iced">
<img src="https://img.shields.io/static/v1?label=Status&message=Early%20Development&color=blue">

</div>

<!-- PROJECT LOGO -->
<br />
</br>
<div align="center">
<a href="https://github.com/polyphony-chat/polyphony">
<img src="https://github.com/polyphony-chat/design/blob/main/branding/polyphony-2-4.png?raw=true" alt="Logo" width="128" height="128">
<a href="https://github.com/polyphony-chat/polyphony-web">
<img src="https://github.com/polyphony-chat/branding/blob/main/logos/polyphony-2-5-round8bit.png?raw=true" alt="The Polyphony logo. a purple, square background with rounded edges. on this background, there are four vertically stacked, white lines. The lines each resemble a sine curve, although they are all shaped a little differently." width="128" height="128">
</a>

<h3 align="center">Polyphony</h3>
<h3 align="center">Polyphony Web</h3>

<p align="center">
A multi-instance, Discord/Spacebar API-compatible chat client, written in Rust, using Iced.
A multi-instance, cross-platform Discord/Spacebar API-compatible chat client, written in Rust using leptos and optionally Tauri.
<br />
<a href="https://github.com/polyphony-chat/polyphony"><strong>Explore the docs »</strong></a>
<a href="https://github.com/polyphony-chat/polyphony-web"><strong>Explore the docs »</strong></a>
<br />
<br />
<a href="https://github.com/polyphony-chat/polyphony/issues">Report Bug</a>
<a href="https://github.com/polyphony-chat/polyphony-web/issues">Report Bug</a>
·
<a href="https://github.com/polyphony-chat/polyphony/issues">Request Feature</a>
<a href="https://github.com/polyphony-chat/polyphony-web/issues">Request Feature</a>
·
<a href="https://discord.gg/8tKSC8wzDq">Join Discord</a>
</p>
</div>

<!-- ABOUT THE PROJECT -->

## About The Project

![Product Mockup](https://raw.githubusercontent.com/polyphony-chat/design/main/ui/client-mockup-draft-neo.png)
<cite>_A mockup of the Polyphony client._</cite>

Polyphony will be a multi-instance, Discord/Spacebar API-compatible chat client, written in Rust, using Iced. The three goals of this project are ease of use, user experience and performance.

Ideally, you will be able to connect to multiple Spacebar instances at the same time and use the client just like you would expect a regular Discord client to work.
</div>

### Spacebar? What's that?
## Setting up a dev environment

[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_".
Add wasm as a compilation target

```bash
rustup target add wasm32-unknown-unknown
```

## Contact
Install `tauri-cli` and `trunk`
```bash
cargo install tauri-cli trunk --locked
```

florian@pro-weber.com
To start the web-based application, change into the `crates/polyphony-wasm` directory and run `trunk serve`.

To start the Tauri powered Desktop-App instead, change into the `crates/polyphony-tauri` directory and run `cargo tauri dev`.

<p align="right">(<a href="#readme-top">back to top</a>)</p>
> Note that the Tauri Dev Server will try to run and listen for the `trunk serve` Dev server. If it fails to do so (perhaps because Port `8080` is already occupied), it will not be able to start the Tauri App.
[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
[contributors-url]: https://github.com/polyphony-chat/polyphony/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/polyphony-chat/polyphony.svg?style=flat
[forks-url]: https://github.com/polyphony-chat/polyphony/network/members
[stars-shield]: https://img.shields.io/github/stars/polyphony-chat/polyphony.svg?style=flat
[stars-url]: https://github.com/polyphony-chat/polyphony/stargazers
[issues-shield]: https://img.shields.io/github/issues/polyphony-chat/polyphony.svg?style=flat
[issues-url]: https://github.com/polyphony-chat/polyphony/issues
[license-shield]: https://img.shields.io/github/license/polyphony-chat/polyphony.svg?style=flat
[license-url]: https://github.com/polyphony-chat/polyphony/blob/master/LICENSE
[svelte.dev]: https://img.shields.io/badge/Svelte-4A4A55?style=plastic&logo=svelte&logoColor=FF3E00
[svelte-url]: https://svelte.dev/
[rust]: https://img.shields.io/badge/Rust-orange?style=flat&logo=rust
[rust-url]: https://www.rust-lang.org/
[typescript]: https://img.shields.io/badge/TypeScript-blue?style=plastic&logo=typescript&logoColor=FFFFFF
[typescript-url]: https://www.typescriptlang.org/
[Rust]: https://img.shields.io/badge/Rust-orange?style=plastic&logo=rust
[Rust-url]: https://www.rust-lang.org/
[build-shield]: https://img.shields.io/github/actions/workflow/status/polyphony-chat/polyphony-web/rust.yml?style=flat
[build-url]: https://github.com/polyphony-chat/polyphony-web/blob/main/.github/workflows/rust.yml
[contributors-shield]: https://img.shields.io/github/contributors/polyphony-chat/polyphony-web.svg?style=flat
[contributors-url]: https://github.com/polyphony-chat/polyphony-web/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/polyphony-chat/polyphony-web.svg?style=flat
[forks-url]: https://github.com/polyphony-chat/polyphony-web/network/members
[stars-shield]: https://img.shields.io/github/stars/polyphony-chat/polyphony-web.svg?style=flat
[stars-url]: https://github.com/polyphony-chat/polyphony-web/stargazers
[issues-shield]: https://img.shields.io/github/issues/polyphony-chat/polyphony-web.svg?style=flat
[issues-url]: https://github.com/polyphony-chat/polyphony-web/issues
[license-shield]: https://img.shields.io/github/license/polyphony-chat/polyphony-web.svg?style=f;at
[license-url]: https://github.com/polyphony-chat/polyphony-web/blob/master/LICENSE
[Discord]: https://dcbadge.vercel.app/api/server/m3FpcapGDD?style=flat
[Discord-invite]: https://discord.com/invite/m3FpcapGDD

0 comments on commit 228c25e

Please sign in to comment.