Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/smaug6739/instant-chat
An instant chat with member area, rooms with socket.io, vuejs and typescript.
https://github.com/smaug6739/instant-chat
backend frontend instant-chat instant-messaging socket typescript vuejs
Last synced: 6 days ago
JSON representation
An instant chat with member area, rooms with socket.io, vuejs and typescript.
- Host: GitHub
- URL: https://github.com/smaug6739/instant-chat
- Owner: Smaug6739
- License: mit
- Created: 2021-05-15T19:34:51.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-08-03T17:16:15.000Z (over 1 year ago)
- Last Synced: 2024-05-01T17:33:01.145Z (7 months ago)
- Topics: backend, frontend, instant-chat, instant-messaging, socket, typescript, vuejs
- Language: Vue
- Homepage:
- Size: 913 KB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Instant chat
This project is an instant chat with a member area, using socket.io, vuejs and typescript.
## Infos
### Backend
- Expressjs version 4
- Socket.io version 5
- Authentification: Json Web Token
### Frontend
- Vuejs version 3
- Socket.io-client version 4
## How to install
1. Clone the repo
### Backend
1. Clone config.template.ts into the `backend/src` directory and rename it to config.ts
2. In `backend` directory install the dependencies: `npm install`
3. Compile typescript : `tsc`
4. Start the server : `npm run start`
### Frontend
1. Clone config.template.js into the `frontend` directory and rename it to config.js
2. In `frontend` directory install the dependencies: `npm install`
3. Compile scss `npm run sass`
4. Start the developement server with `npm run serve` or create a production build with `npm run build` and start with `serve dist`
## Contributions/Licence
This project is still in development and has an MIT license.
If you wish, you are welcome to contribute.