Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ru-dr/socket-deno
This is a simple WebSocket chat application template built with Deno 🦕 and the Oak 🐿️. It provides a starting point for developing real-time chat applications using WebSockets.
https://github.com/ru-dr/socket-deno
deno denoland js onrender-deploy websocket
Last synced: 2 months ago
JSON representation
This is a simple WebSocket chat application template built with Deno 🦕 and the Oak 🐿️. It provides a starting point for developing real-time chat applications using WebSockets.
- Host: GitHub
- URL: https://github.com/ru-dr/socket-deno
- Owner: ru-dr
- License: mit
- Created: 2024-08-26T06:01:51.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-08-29T04:25:09.000Z (4 months ago)
- Last Synced: 2024-09-29T18:41:02.827Z (3 months ago)
- Topics: deno, denoland, js, onrender-deploy, websocket
- Language: JavaScript
- Homepage: https://socket-deno.onrender.com/
- Size: 38.1 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Socket Deno 🔌🦕
## Overview 📚
This is a simple WebSocket chat application template built with Deno 🦕 and the Oak 🐿️. It provides a starting point for developing real-time chat applications using WebSockets.
## Previews 🙈
### Home Page 🏠
### Chat Page 🗣️
## Features ✨
- **Real-time messaging** using WebSockets 📡
- **Displays online users** in each room 👥
- Powered by **Deno** and the **Oak** web framework 🚀
## Getting Started 🚀
### Setup on Render 🛠️
**Deno**: The project uses Deno as the runtime. It's automatically installed during the build process.
- **Environment Variable**:
- `DENO_INSTALL` should be set to `/opt/render/project/.deno`.
- **Build Command**:
This command installs Deno on the Render platform:
```sh
curl -fsSL https://deno.land/install.sh | sh
```
- **Start Command**:
This command sets up the environment and starts the application:
```sh
export PATH="$DENO_INSTALL/bin:$PATH" && deno run --allow-net --allow-read server.js
```
### Local Development 💻
If you want to run the application locally, follow these steps:
1. **Install [Deno](https://deno.land/) on your machine** 🦕.
2. **Clone the repository**:
```sh
git clone https://github.com/ru-dr/socket-deno.git
```
3. **Navigate to the project directory**:
```sh
cd socket-deno-template
```
4. **Start the development server**:
```sh
deno run --allow-net --allow-read server.js
```
### Usage 📡
Once the application is running, you can connect to the WebSocket server using a client (e.g., a web browser or a WebSocket client tool). The application supports basic real-time messaging.
### Deployment 🚀
To deploy the application on Render:
1. **Push your code to a GitHub repository** 🗂️.
2. **Connect the repository to your Render account** 🔗.
3. **Configure the environment variable and commands** as described above 🛠️.
4. **Deploy your service** 🚀.
To deploy the application on Deno Deploy:
1. **Push your code to a GitHub repository** 🗂️.
2. **Connect the repository to your Deno Deploy account** 🔗.
3. **Select the framework as None**.
4. **Do not change any other configurations**.
5. **Select the root file as server.js and click deploy 🚀**.
### Demo 🌐
- [OnRender Version](https://socket-deno.onrender.com/) - Check out the live application in action
- [Deno Deploy Version](https://socket-d3no.deno.dev/) - See the app running on Deno Deploy
### Contributing 🤝
Feel free to submit issues or pull requests if you find any bugs or have suggestions for improvements.
### License 📄
This project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for more details.
---
Happy coding with Deno! 🦕🔌