Cordux

A third-party Discord client that reimplements the Discord API built with React.

Usage

Cordux tries to look as close as the official Discord client, use it like you would with normal Discord.

There's no desktop client at the moment, use the web app instead.

Prerequisites

Next, you can clone the repository using Git:

git clone https://github.com/frolleks/cordux
cd cordux

Then, you install the dependencies with yarn:

yarn

After that, you can run Cordux in development mode:

yarn dev

You may also build for production:

yarn build

Before contributing to Cordux, create a fork of the repo first.

Clone your fork, and it's recommended to make a new branch to push your changes to, so that conflicts won't happen. To create a new branch, run:

git checkout -b ＜new-branch＞

You may also create a new branch in GitHub by clicking on the branch name then type the name of your new branch.

If you did it on GitHub after you cloned the repository, pull the changes by running git pull.

You can now switch into the branch if you made it in GitHub by running:

git checkout <new-branch>

Congrats! You can now contribute to Cordux.

But, there's a guideline.

You must follow the Conventional Commits specification for your commit messages.

Submitting changes to the main repo

You may open a pull request and submit it to the main repo.

If you didn't follow the Conventional Commits specification on your commits, we will rename your PR title to follow the spec.

This project is licensed under the BSD 3-Clause license.