Skip to content

Commit

Permalink
Initial commit 3000
Browse files Browse the repository at this point in the history
  • Loading branch information
@bitfl0wer
bitfl0wer committed Aug 27, 2023
1 parent 823d91b commit b70cb92
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 184 deletions.
5 changes: 5 additions & 0 deletions .rusty-hook.toml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
[hooks]
pre-commit = "cargo fmt -p polyphony-native && exit 0"

[logging]
verbose = true
8 changes: 7 additions & 1 deletion Cargo.toml
View file
Original file line number Diff line number Diff line change
@@ -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"
183 changes: 0 additions & 183 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,30 +35,6 @@
</p>
</div>

<!-- TABLE OF CONTENTS -->
<details>
<summary>Table of Contents</summary>
<ol>
<li>
<a href="#about-the-project">About The Project</a>
<ul>
<li><a href="#built-with">Built With</a></li>
</ul>
</li>
<li>
<a href="#getting-started">Getting Started</a>
<ul>
<li><a href="#prerequisites">Prerequisites</a></li>
</ul>
</li>
<li><a href="#roadmap">Roadmap</a></li>
<li><a href="#contributing">Contributing</a></li>
<li><a href="#license">License</a></li>
<li><a href="#contact">Contact</a></li>
<li><a href="#acknowledgments">Acknowledgments</a></li>
</ol>
</details>

<!-- ABOUT THE PROJECT -->

## About The Project
Expand All @@ -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_".

<p align="right">(<a href="#readme-top">back to top</a>)</p>

### Built With

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

<p align="right">(<a href="#readme-top">back to top</a>)</p>

<!-- GETTING STARTED -->

## 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.

<details>
<summary>Linux</summary>

### Prerequisites: Linux

Install the rust toolchain and cargo.

```bash
curl --proto '=https' --tlsv1.2 -sSf <https://sh.rustup.rs> | sh
```

Install Node.js v19 and yarn

Arch Linux:

```bash
sudo pacman -S nodejs yarn
```

Debian/Ubuntu:

```bash
curl -fsSL <https://deb.nodesource.com/setup_19.x> | sudo -E bash -
sudo apt-get install -y nodejs
sudo npm install -g yarn
```

</details>

<details>
<summary>macOS</summary>

### Prerequisites: macOS

Install Homebrew, if you haven't already:

```bash
/bin/bash -c $(curl -fsSL <https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh>)
```

Install the rust toolchain and cargo:

```bash
brew install rustup-init
rustup-init
```

Install Node.js v19 and yarn:

```bash
brew install node yarn
```

</details>

<details>
<summary>Windows</summary>

### Prerequisites: Windows

Install the rust toolchain and cargo:

1. Download and run the rustup-init.exe from <https://rustup.rs/>
2. Follow the instructions to complete the installation.

Install Node.js v19 and yarn:

1. Download the installer from <https://nodejs.org/en/download/>
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
```

</details>

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.

<p align="right">(<a href="#readme-top">back to top</a>)</p>

## Roadmap

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

<p align="right">(<a href="#readme-top">back to top</a>)</p>

<!-- CONTRIBUTING -->

## 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

<p align="right">(<a href="#readme-top">back to top</a>)</p>

<!-- LICENSE -->

## License

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

<p align="right">(<a href="#readme-top">back to top</a>)</p>

<!-- CONTACT -->

## Contact

florian@pro-weber.com

Project Link: [https://github.com/polyphony-chat/polyphony](https://github.com/polyphony-chat/polyphony)

<p align="right">(<a href="#readme-top">back to top</a>)</p>

<!-- ACKNOWLEDGMENTS -->
<!-- TODO>
## Acknowledgments
* []()
* []()
* []()

<p align="right">(<a href="#readme-top">back to top</a>)</p>

<!-- MARKDOWN LINKS & IMAGES -->
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->

[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
Expand Down

0 comments on commit b70cb92

Please sign in to comment.