shockrah/freechat
shockrah/freechat
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

More background information regarding what can use the help or not

Browse Source 
* Better wording in readme about chat history
This commit is contained in:
shockrah 2020-12-12 16:36:40 -08:00
parent f7136c0258
commit ba13de2064
2 changed files with 8 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
contributing.md
View File

@ -13,14 +13,18 @@ If you choose to write a client and want people to know about it I can include a
Currently API testing is done with a phony client written in python(client-tests/client.py) and some rust tests. Currently API testing is done with a phony client written in python(client-tests/client.py) and some rust tests.
Anything from a simple `GET /some-route` + response check to a testing pipeline thing is appreciated. Anything from a simple `GET /some-route` + response check to a testing pipeline thing is appreciated.
Since testing doesn't really affect users as long as the test is correct and covers new ground it's welcome. Since testing doesn't really affect users, as long as the test is correct and covers new ground it's welcome.
* Languages - Rust/Python/Bash/Javascript/HTML/CSS * Languages - Rust/Python/Bash/Javascript/HTML/CSS
The API service is written in rust. Uses mysql-async wrapped in a small library for abstracting away database code from the "business logic" The API service is written in rust. Uses mysql-async wrapped in a small library for abstracting away database code from the "business logic"
Build scripts are literally just Bash scripts * Scripting
Build scripts are literally just Bash scripts so if a script looks like it can be used to automate some boring process then that could be a great way to contribute.
* Electron Client
The electron client is built with NodeJS + Bootstrap(nothing else). The electron client is built with NodeJS + Bootstrap(nothing else).
Adding libraries to the client requires _very_ good reason IMO. Adding libraries to the client requires _very_ good reason IMO.
I know Electron is a whale so I want to do everything in my power to make sure it doesn't weigh much more.

2
readme.md
View File

@ -14,7 +14,7 @@ Mumble could work but has an awful reputation amongst regular non-technical user
> So it's a Discord/Slack clone? > So it's a Discord/Slack clone?
Not really, at least for now chat history is limited kinda like basically every chan/booru. _This can be turned off to preserve all chat history_. Chat history is limited similar to nearly every chan/booru. _This can be turned off to preserve all chat history_.
The biggest difference is the lack of data collection; servers collect the following data: The biggest difference is the lack of data collection; servers collect the following data: