Added readme.
This commit is contained in:
parent
58b99ac3df
commit
3d607984d3
4 changed files with 19 additions and 5 deletions
2
.gitignore
vendored
Normal file
2
.gitignore
vendored
Normal file
|
@ -0,0 +1,2 @@
|
|||
node_modules
|
||||
package-lock.json
|
|
@ -1,15 +1,14 @@
|
|||
{
|
||||
"name": "~2024-ia24-chat",
|
||||
"name": "chatto-server",
|
||||
"version": "1.0.0",
|
||||
"main": "index.js",
|
||||
"scripts": {
|
||||
"test": "echo \"Error: no test specified\" && exit 1",
|
||||
"start": "ts-node server.ts"
|
||||
},
|
||||
"keywords": [],
|
||||
"author": "",
|
||||
"author": "Adrian Victor <adrianvictor@disroot.org>",
|
||||
"license": "ISC",
|
||||
"description": "",
|
||||
"description": "A simple ephemeral messaging server",
|
||||
"dependencies": {
|
||||
"ws": "^8.18.0"
|
||||
},
|
||||
|
|
13
readme
Normal file
13
readme
Normal file
|
@ -0,0 +1,13 @@
|
|||
# Chatto
|
||||
This is a chat server that uses WebSocket for communication, born in a college class. It should be as simple as possible, providing a quick way of communication.
|
||||
|
||||
## What Chatto is:
|
||||
- A ephemeral messaging server
|
||||
|
||||
## What Chato is not:
|
||||
- A - in any way - secure messaging server
|
||||
- A messaging app on it's own
|
||||
- Something you should use as a private messaging solution
|
||||
- A server that provides any solution of client-side security (you can uncomment a line to 'disable' HTML injection, but that's all you have server-side), your client will have to handle everything on it's own.
|
||||
|
||||
I'm making this server to learn TS and improve my front-end skills, and I'm planning to host a client in my friend's private website, just to have a waterfall of messages where anyone can send something. The base code was made by my teacher (reportedly using Copilot) so I'm planning to refactor it.
|
|
@ -67,4 +67,4 @@ wss.on('connection', (ws) => {
|
|||
});
|
||||
});
|
||||
|
||||
console.log('WebSocket server is running on ws://localhost:8080');
|
||||
console.log('Chatto WebSocket server is running on ws://localhost:4000');
|
Loading…
Reference in a new issue