https://github.com/frolleks/cordux
A third-party Discord client that reimplements the Discord API
https://github.com/frolleks/cordux
discord discord-api discord-api-wrapper discord-client react
Last synced: about 1 year ago
JSON representation
A third-party Discord client that reimplements the Discord API
- Host: GitHub
- URL: https://github.com/frolleks/cordux
- Owner: frolleks
- License: bsd-3-clause
- Archived: true
- Created: 2022-12-27T05:46:10.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-01-20T01:11:47.000Z (over 3 years ago)
- Last Synced: 2025-02-25T05:17:31.287Z (over 1 year ago)
- Topics: discord, discord-api, discord-api-wrapper, discord-client, react
- Language: TypeScript
- Homepage: https://cordux.vercel.app
- Size: 1.86 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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.
## Installation
There's no desktop client at the moment, use the [web app](https://cordux.vercel.app) instead.
## Contributing
### Setting up your development environment
**Prerequisites**
- Git (2.x.x or above)
- Node.js (16.x or above)
- yarn (3.x)
Next, you can clone the repository using Git:
```sh
git clone https://github.com/frolleks/cordux
cd cordux
```
Then, you install the dependencies with yarn:
```sh
yarn
```
After that, you can run Cordux in development mode:
```sh
yarn dev
```
You may also build for production:
```sh
yarn build
```
### Contributing changes to Cordux
Before contributing to Cordux, [create a fork](https://github.com/frolleks/cordux/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:
```sh
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:
```sh
git checkout
```
Congrats! You can now contribute to Cordux.
But, there's a guideline.
You must follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification for your commit messages.
**Submitting changes to the main repo**
You may [open a pull request](https://github.com/frolleks/cordux/compare) 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.
## License
This project is licensed under the [BSD 3-Clause](LICENSE) license.