# @vstoodeeoh/vschat-server

> Chat server for vs clients

Latest version **1.0.11** (published 2022-09-26) · ISC license · 0 weekly downloads

## Install

```sh
npm install @vstoodeeoh/vschat-server
pnpm add @vstoodeeoh/vschat-server
yarn add @vstoodeeoh/vschat-server
bun add @vstoodeeoh/vschat-server
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.11 |
| Published | 2022-09-26 |
| First published | 2022-09-26 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 6.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Maintainers | sifatdipta |

## Links

- npm: https://www.npmjs.com/package/@vstoodeeoh/vschat-server
- Repository: https://github.com/virtualstoodeeoh-dev/vschat-server
- Homepage: https://github.com/virtualstoodeeoh-dev/vschat-server#readme
- Issues: https://github.com/virtualstoodeeoh-dev/vschat-server/issues
- npm.io page: https://npm.io/package/@vstoodeeoh/vschat-server

## Recent versions

- 1.0.11 (latest) — 2022-09-26
- 1.0.1 — 2022-09-26
- 1.0.0 — 2022-09-26

## README

# Virtual Stoodeeoh - VSChat Server

Allows you to create a chat server with MongoDB and Express for VSChat Clients.

## Requirements

- Express Server
- MongoDB database

## Install

```
npm i @vstoodeeoh/vschat-server
```

## Initialize VSChat

```
const vsChat = require("vs-chat-server");
const express = require("express");
const cors = require("cors");

const app = express();
vsChat.init(app, "mongodb://localhost:27017/chatAppTest", "secret_key"); // Express app, MongoDB con string, secret key

// Middlewares
app.use(cors({ credentials: true, origin: true }));
app.use(express.json({ limit: "50mb" }));

vsChat.listen(8900); // Socket Port Number

app.listen(process.env.PORT || 5555, () => {
  console.log("Server running on port " + 5555);
});
```

## Parameters

### init

- Express Server (Required)
- MongoDB URI (Required)
- Secret Key (Required) // Client's will require this key to access.

### listen

- Socket Port (Required)

## Notes

That's all that required to get started with setting up the chat server.

[Virtual Stoodeeoh Inc.](https://pages.github.com/)

---
_Source: https://npm.io/package/@vstoodeeoh/vschat-server · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._