Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/theycallhermax/gocial-server
The server for Gocial
https://github.com/theycallhermax/gocial-server
gocial server
Last synced: about 6 hours ago
JSON representation
The server for Gocial
- Host: GitHub
- URL: https://github.com/theycallhermax/gocial-server
- Owner: theycallhermax
- License: mit
- Created: 2022-11-17T15:20:11.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-08-30T23:25:58.000Z (about 1 year ago)
- Last Synced: 2024-03-17T23:30:25.154Z (8 months ago)
- Topics: gocial, server
- Language: TypeScript
- Homepage:
- Size: 454 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Gocial Server
The server for Gocial
## Running
```bash
npm install
npm run start
```Then connect to `wss://localhost:3000/` with a WebSocket client.
## Documentation
### Commands
#### Log in
Checks to see if the user exists`{"cmd": "login", "username": "[username]", "password": "[password]"}`
#### Sign up
Creates a new user`{"cmd": "signup", "username": "[username]", "password": "[password]"}`
#### Home
Gets a list of posts`{"cmd": "home"}`
#### Ping
"Pings" the server, sort of like keepalive`{"cmd": "ping"}`
#### Post
Sends a post to home`{"cmd": "post", "username": "[username]", "password": "[password]", "val": "[content]"}`
#### Set Quote
Sets a quote for the specified user`{"cmd": "set_quote", "username": "[username]", "password": "[password]", "val": "[content]"}`