diff --git a/README.md b/README.md index c971412..b1268c9 100644 --- a/README.md +++ b/README.md @@ -1,47 +1,52 @@ ![Build status](https://img.shields.io/github/actions/workflow/status/thuongtruong109/shakemate/build.yml?logo=GitHub&label=build) -![Image status](https://img.shields.io/docker/automated/thuongtruong1009/shakemate?logo=Docker&label=shakemate) +[![Image status](https://img.shields.io/docker/automated/thuongtruong1009/shakemate?logo=Docker&label=shakemate)](https://hub.docker.com/r/thuongtruong1009/shakemate) +[![Website](https://img.shields.io/website?url=https%3A%2F%2Fshakemate.onrender.com&up_color=blue&logo=webrtc)](https://shakemate.onrender.com) [![Donate](https://img.shields.io/badge/Donate-PayPal-ff3f59.svg)](https://paypal.me/thuongtruong1009) -![License](https://img.shields.io/github/license/thuongtruong1009/short1url) +![License](https://img.shields.io/github/license/thuongtruong109/shakemate) # shakemate > 🖇ïļ Connect to temp peers via internal network without authentication -## Preview +## ðŸŽŦ Preview ![Preview](/public/preview.png) -## Motivation +![Preview 2](/public/preview_2.png) + +## ðŸ”Ĩ Motivation I wanted to create a simple way to connect to peers via internal network without any authentication. This is useful for temporary connections where you don't want to go through the hassle of creating an account or sharing a link. Just connect to the server and start sharing. Usecases include sharing files, camera, chat, etc. -## Features - -- ðŸ“Ķ **Zero-config**: No need to configure anything, just run the server and connect to it -- 🌐 **Internal network**: Connect to the server via internal network -- 🚀 **Fast**: No authentication required, just connect and start sharing -- ðŸ“ą **Responsive**: Works on all devices -- ðŸ“Ą **Real-time**: Uses WebRTC for real-time communication -- 📁 **File sharing**: Share files with peers -- ðŸ“đ **Camera sharing**: Share your camera with peers -- 💎 **Chat**: Chat with peers -- 🎧 **Audio sharing**: Share audio with peers -- 📝 **Rich text editor**: Write notes with rich text editor - -## Tech Stack - -- **Fastify x ejs**: Web framework for Node.js with EJS template engine -- **Socket.io**: Real-time communication library -- **Peerjs**: Simple peer-to-peer with WebRTC -- **Docker**: Containerization platform -- **FontAwesome**: Icon library -- **JavaScript/Typescript**: Programming language -- **HTML/CSS**: Markup and styling language -- **Tinymce**: Rich text editor - -## How to use - -with npm/yarn/... +## ðŸŠķ Features + +- ðŸ“Ķ **Zero-config**: No need to configure anything, just run the server and connect to it +- 🌐 **Internal network**: Connect to the server via internal network +- 🚀 **Fast**: No authentication required, just connect and start sharing +- ðŸ“ą **Responsive**: Works on all devices +- ðŸ“Ą **Real-time**: Uses WebRTC for real-time communication +- 📁 **File sharing**: Share files with peers +- ðŸ“đ **Camera sharing**: Share your camera with peers +- 💎 **Chat**: Chat with peers +- 🎧 **Audio sharing**: Share audio with peers +- 📝 **Rich text editor**: Write notes with rich text editor + +## 🏗ïļ Tech Stack + +- **Fastify x ejs**: Web framework for Node.js with EJS template engine +- **Socket.io**: Real-time communication library +- **Peerjs**: Simple peer-to-peer with WebRTC +- **Docker**: Containerization platform +- **FontAwesome**: Icon library +- **JavaScript/Typescript**: Programming language +- **HTML/CSS**: Markup and styling language +- **Tinymce**: Rich text editor +- **Cloudinary**: Image hosting service + +## ðŸ”Ļ How to use + +with npm/yarn/pnpm... + ```bash npm install ``` @@ -58,8 +63,8 @@ docker-compose up -> Then open `http://localhost:3000` in your browser -## License +## 🊊 License [MIT](LICENSE) ÂĐ Thuong Truong, 2024 - \ No newline at end of file + diff --git a/docker-compose.yml b/docker-compose.yml index 19f87ef..2059086 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -1,13 +1,14 @@ -version: "3.7" +version: '3.7' services: - app: - image: thuongtruong1009/shakemate - container_name: shakemate - build: - context: . - dockerfile: Dockerfile - ports: - - "3000:3000" - volumes: - - .:/app + app: + image: thuongtruong1009/shakemate + container_name: shakemate + build: + context: . + dockerfile: Dockerfile + ports: + - '3000:3000' + volumes: + - .:/app + - /app/node_modules diff --git a/package.json b/package.json index a136324..b0d948a 100644 --- a/package.json +++ b/package.json @@ -1,5 +1,14 @@ { "name": "shakemate", + "description": "🖇ïļ Connect to temp peers via internal network without authentication", + "author": { + "name": "Tran Nguyen Thuong Truong", + "email": "thuongtruong@proton.me" + }, + "repository": { + "type": "git", + "url": "git+https://github.com/thuongtruong109/shakemate.git" + }, "version": "1.0.0", "main": "dist/app.js", "license": "MIT", diff --git a/public/assets/css/styles.css b/public/assets/css/styles.css index c116d7a..de67c36 100644 --- a/public/assets/css/styles.css +++ b/public/assets/css/styles.css @@ -1,6 +1,3 @@ -@import url('https://fonts.googleapis.com/css2?family=Be+Vietnam+Pro:ital,wght@0,300;0,400;0,500;0,600;1,400&display=swap'); -@import url('https://fonts.googleapis.com/css2?family=Black+Ops+One&display=swap'); - * { padding: 0; margin: 0; @@ -36,7 +33,7 @@ body { color: white; font-weight: 600; font-size: 3rem; - font-family: "Black Ops One", system-ui; + font-family: 'Black Ops One', system-ui; font-style: normal; } @@ -207,7 +204,7 @@ body { } .chat .chat-content-message { - background: #F0F0F0; + background: #f0f0f0; border-radius: 0.75rem; padding: 5px 10px; max-width: fit-content; @@ -216,7 +213,7 @@ body { .chat .chat-content-message.you { text-align: right; margin-left: auto; - background: #6CACE4; + background: #6cace4; color: white; } @@ -319,7 +316,9 @@ span { visibility: hidden; } -.tox, .tox-tinymce, .tox-editor-container { +.tox, +.tox-tinymce, +.tox-editor-container { max-height: 50px !important; height: 50px !important; width: 230px !important; @@ -334,4 +333,4 @@ span { width: 80px !important; height: 80px !important; overflow: hidden !important; -} \ No newline at end of file +} diff --git a/public/header.ejs b/public/header.ejs index f9f0cc3..2975e31 100644 --- a/public/header.ejs +++ b/public/header.ejs @@ -4,5 +4,16 @@ - -Shakemate \ No newline at end of file + + + +Shakemate diff --git a/public/preview_2.png b/public/preview_2.png new file mode 100644 index 0000000..da5dba3 Binary files /dev/null and b/public/preview_2.png differ diff --git a/src/app.ts b/src/app.ts index 9a669fb..b1a1284 100644 --- a/src/app.ts +++ b/src/app.ts @@ -12,6 +12,8 @@ import handleWS from './utils/handleWebsocket'; dotenv.config(); const server = fastify({ logger: true }); +const PORT = +Number.parseInt(process.env.PORT) || 3000; + (async () => { try { startCron(); @@ -36,14 +38,13 @@ const server = fastify({ logger: true }); fastify.get('/ws', { websocket: true }, handleWS(server.log)); }); - - server.listen({ port: 3000, host: '0.0.0.0' }, (err) => { + server.listen({ port: PORT, host: '0.0.0.0' }, (err) => { if (err) { - console.error(err) - process.exit(1) + console.error(err); + process.exit(1); } - console.log('Server listening at http://localhost:3000') - }) + console.log(`::: -> Server listening at http://localhost:${PORT}`); + }); } catch (err) { server.log.error(err); process.exit(1);