https://github.com/winterrdog/chosen-chat-app
a personal portfolio project geared to learning websockets and real-time chats or updates
https://github.com/winterrdog/chosen-chat-app
chat-room nestjs-backend nodejs real-time websockets
Last synced: 3 months ago
JSON representation
a personal portfolio project geared to learning websockets and real-time chats or updates
- Host: GitHub
- URL: https://github.com/winterrdog/chosen-chat-app
- Owner: winterrdog
- License: mit
- Created: 2023-12-31T06:31:38.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-02-23T08:55:39.000Z (over 1 year ago)
- Last Synced: 2025-03-27T21:11:45.965Z (3 months ago)
- Topics: chat-room, nestjs-backend, nodejs, real-time, websockets
- Language: CSS
- Homepage: https://muchubatactics.github.io/chosen-chat-app/
- Size: 482 KB
- Stars: 3
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# The chosen-chat-room app
a personal project geared to learning websockets and real-time chats or updates
## Frontend
The front-end is a static HTML page that uses the backend API to send and receive messages.
### Note: The front end is only styled for Desktop.
#### The front-end is hosted here
--> https://muchubatactics.github.io/chosen-chat-app/ <--
If you clone the repo and you want to run it locally, follow the instructions below.
To run the front-end, you just need a browser.
#### Steps to run the front-end
- Open the front-end folder
- Click on the `index.html` file to open the app in your browser
## Backend
#### Installation
- Make sure you've `docker` installed on your machine. *The rest of the dependencies will be installed in a container so you don't need to worry about them*
#### Running the app
- This app is containerized, so you can run it by running the following command in the root directory of the app
```bash
cd back-end && bash ./containerize.sh
```
This will pull the app's image from docker hub and run it in a container. The app will be running on port `3000` at a URL of `http://localhost:3000`
## NOTES
- By default, the websocket server is running on port `3000` at a URL of `http://localhost:3000`