Skip to content

Description update #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Calemy wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Description update #3

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7e3d55e
Updated description
Calemy Apr 25, 2021
0fa3df7
oopsie
Calemy Apr 25, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,13 @@ SOCKET STATS | DASHBOARD for DISCORD BOT STATS
![dashboard](https://cdn.discordapp.com/attachments/664516457542975492/746637803332304966/unknown.png)

</center>
This dasboard base on Bootstrap and chart.js. then for the comunication we open a websocket using socket.io

installing this package and complete all requirement, ur project will automatically make websocket server and open new routing following `http://localost:8080/gb-status`. or `<project_url>/gb-status`


> The following example attaches project to a plain Node.JS HTTP server listening on port 8080 .
This dashboard is based on Bootstrap and chart.js. For the communication we open a websocket using socket.io

installing this package will complete all requirements. Your project will automatically create a websocket server and open new routing following `http://localost:8080/gb-status`. or `<project_url>/gb-status`


## Requirement
this project require following packages:
This project require following packages:
+ [express](https://www.npmjs.com/package/express)
+ [socket.io](https://www.npmjs.com/package/socket.io)
+ [os-utils](https://www.npmjs.com/package/os-utils)
Expand All @@ -26,9 +22,13 @@ install the package using:
```
$ npm install socketstats
```
or
```
$ npm -i socketstats
```

### Basic routing
then use express and create express basic routing.
Then use express and create a basic routing.
> The following example attaches project to a plain Node.JS HTTP server listening on port 8080 .
```js
const express = require("express");
Expand All @@ -47,9 +47,9 @@ app.listen(_PORT, () => {

```

to make `WebServer` and `WebSocket` **run in singgle server**. You need to pass the `Server` to `socketstats`, and not the express application function. Also make sure to call `.listen` on the `server`, not the `app`.
To make `WebServer` and `WebSocket` **run on a single server**. You need to pass the `Server` to `socketstats`, and not to the express application. So make sure to call `server.listen` instead of `app.listen`.

then for gathering info from the bot we need authorize `client` fom discord. so we do listen to port after te bot is ready.
For gathering info from the bot we need to authorize `client` from Discord. So we call the server in the ready function.
```js
const express = require("express");
const app = express();
Expand Down