-
Notifications
You must be signed in to change notification settings - Fork 6
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Fix Typos #4
Merged
Merged
Fix Typos #4
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
name: typos | ||
|
||
on: | ||
push: | ||
branches: ["main"] | ||
pull_request: | ||
branches: ["main"] | ||
|
||
env: | ||
CARGO_TERM_COLOR: always | ||
|
||
jobs: | ||
check: | ||
runs-on: ubuntu-latest | ||
|
||
steps: | ||
- uses: actions/checkout@v4 | ||
- name: typos-action | ||
uses: crate-ci/typos@master | ||
with: | ||
files: . |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,58 +1,76 @@ | ||
# Matthias | ||
|
||
A (soon to be) multiplatform self-hosted chat application built completely in Rust. | ||
|
||
## Features | ||
| Features | Desktop | Mobile | | ||
| -------- | ------- | ------- | | ||
| Encrypted messages ensuring security | ✅ | ✅ | | ||
| Backend which doesn't rely on any central provider | ✅ | ✅ | | ||
| Customizable profiles | ✅ | ✅ | | ||
| Text, audio, image, file messages, and images | ✅ | ✅ | | ||
| Custom emojis | ✅ | ✅ | | ||
| Intuitive user interface | ✅ | ✅ | | ||
| Experimental MD (Markdown) support | ✅ | ✅ | | ||
| Voice calls | ✅ | ❌ | | ||
| Extensive lua (using luajit) API with documentation at [Gitbook](https://matthias.gitbook.io/) with external libs available | ✅ | ❌ | | ||
| Custom connection urls (If the app is installed through the installer) This allows the user to connect to a server with just a link | ✅ | ❌ | | ||
|
||
| Features | Desktop | Mobile | | ||
| ----------------------------------------------------------------------------------------------------------------------------------- | ------- | ------ | | ||
| Encrypted messages ensuring security | ✅ | ✅ | | ||
| Backend which doesn't rely on any central provider | ✅ | ✅ | | ||
| Customizable profiles | ✅ | ✅ | | ||
| Text, audio, image, file messages, and images | ✅ | ✅ | | ||
| Custom emojis | ✅ | ✅ | | ||
| Intuitive user interface | ✅ | ✅ | | ||
| Experimental MD (Markdown) support | ✅ | ✅ | | ||
| Voice calls | ✅ | ❌ | | ||
| Extensive lua (using luajit) API with documentation at [Gitbook](https://matthias.gitbook.io/) with external libs available | ✅ | ❌ | | ||
| Custom connection urls (If the app is installed through the installer) This allows the user to connect to a server with just a link | ✅ | ❌ | | ||
|
||
**Disclaimer: The application has never been security audited, and has known flaws.** | ||
|
||
### Additional Features (For desktop only): | ||
|
||
- Windows installer (Using a Visual Studio project) | ||
|
||
# Children repositories (Crates/Repos created for the purpose of showcasing/improving Matthias) | ||
|
||
- [Wincam](https://github.com/marci1175/wincam) (Used to capture images from the host's camera) | ||
- [Protocol Showcase](https://github.com/marci1175/matthias-tokio-protocol/tree/master) (Used to showcase Matthias's TCP protocol) | ||
- [mLua proc macro](https://github.com/marci1175/mlua_proc_macro) (Used in creating the lua API) | ||
|
||
_________________________________________________________ | ||
__All this__ with great performance, due to the project being multi-threaded, using async calls with egui, and many more! | ||
--- | ||
|
||
**All this** with great performance, due to the project being multi-threaded, using async calls with egui, and many more! | ||
I have also tried to make my codebase futureproof by implementing custom automatizations (Example: code generating for emojis) and custom proc macros. | ||
_________________________________________________________ | ||
|
||
--- | ||
|
||
## How to compile: | ||
|
||
- First, you must have the Rust compiler installed on your computer with all of its dependencies. | ||
- The next step is to download the source code of this project. (whether that be git cloning or downloading it from github's website) | ||
- Navigate to the source folder and run ```cargo r --release``` (Or without --release for debugging) | ||
- Navigate to the source folder and run `cargo r --release` (Or without --release for debugging) | ||
- Please note that some features may not be available when running the application after compilation (For links to work you must "install" the application through the installer provided) | ||
|
||
### How to create an installer (Note: You must have the Visual Studio installed for this): | ||
|
||
- Navigate to `desktop/Installer` in the project folder, and open up the Matthias.sln file. | ||
- Click on build on the top menu bar and click Build Solution (Or use the `ctrl+shift+b` key combination) | ||
- After building go to `desktop/Installer/MatthiasSetup/Release/` and you will find two files: | ||
- One containing the dependencies (Smaller file size) | ||
- One containing the application itself (Bigger file size) | ||
|
||
## Community | ||
|
||
Feel free to chat in the official [Matthias discord server](https://discord.gg/66KFkByMGa)! | ||
|
||
## Preview | ||
|
||
### Lua API | ||
|
||
![lua api](https://github.com/marci1175/Matthias/blob/813d91dec618beca08e85f9c09e7acb1d977c03d/.github/assets/luaapi.png) | ||
|
||
### Messages | ||
|
||
![Messages](https://github.com/marci1175/Matthias/blob/813d91dec618beca08e85f9c09e7acb1d977c03d/.github/assets/messages.png) | ||
|
||
### Register page | ||
|
||
![Register page](https://github.com/marci1175/Matthias/blob/813d91dec618beca08e85f9c09e7acb1d977c03d/.github/assets/register.png) | ||
|
||
**When wanting to install both, start by opening up the smaller file (Dependency installer), it will automatically open up the application installer.** | ||
|
||
# Legacy | ||
|
||
- The predecessor of Matthias was [ChatApp](https://github.com/marci1175/ChatApp) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,12 +1,14 @@ | ||
# Security Policy | ||
|
||
## Supported Versions | ||
Only the latest verison of the application will recive security updates, as I am not going to maintain older versions of the app. | ||
|
||
Only the latest version of the application will receive security updates, as I am not going to maintain older versions of the app. | ||
|
||
## Reporting a Vulnerability | ||
|
||
Write an accurate description of what this vulnerability is capable of. | ||
Write an accurate step-by-step tutorial on how to replicate/exploit a bug in the app. | ||
|
||
## Report outcomes | ||
If the vulnerability report is accepted, a fix for it will most likely be present in the next quickfix/version. | ||
|
||
If the vulnerability report is accepted, a fix for it will most likely be present in the next quickfix/version. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
[default.extend-words] | ||
caf = "caf" | ||
|
||
[files] | ||
extend-exclude = ["*.vdproj"] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Change ˙ubuntu-latest˙ to ˙windows-latest˙, since my project doesnt compile to linux as of now
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is just a spell checker,not a compilation process.So choosing ubuntu will run this action faster than choosing windows.