https://github.com/steevedroz/diskuss
A chat server that offers an API but no client
https://github.com/steevedroz/diskuss
api chat educational-project server
Last synced: 10 months ago
JSON representation
A chat server that offers an API but no client
- Host: GitHub
- URL: https://github.com/steevedroz/diskuss
- Owner: SteeveDroz
- License: mit
- Created: 2016-06-03T10:44:43.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2017-12-15T09:16:44.000Z (over 8 years ago)
- Last Synced: 2025-06-24T02:20:09.923Z (12 months ago)
- Topics: api, chat, educational-project, server
- Language: JavaScript
- Size: 134 KB
- Stars: 3
- Watchers: 1
- Forks: 3
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: changelog.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
# Diskuss
[](https://travis-ci.org/SteeveDroz/diskuss)
Diskuss is a Node.js chat server that offers an API but no official client.
## Install
1. This application requires **[node.js](https://nodejs.org/en/download/)** and **NPM** (included with Node.js), please install it if you haven't.
2. Download the [latest version](https://github.com/SteeveDroz/diskuss/releases/latest) of diskuss and unzip it.
3. From the directory where `server.js` is located, use the command line `npm install` to download and install dependencies.
4. Run the server with `npm start`.
5. Open a browser (or IE if you don't have any) and connect to your server on port 8081\. If you access that address from the same computer as the one you started the server on, simply follow **[this link](http://127.0.0.1:8081)**. The description of the API is located at the root of the application.
## About Diskuss
### The project
Diskuss was originally created for a school project. It has been made by a teacher whose students had to learn about RESTful APIs. The goal of the exercise was to create a client for Diskuss, each student using a different language and implementing what they thought was interresting to add client-side.
As many other chat servers and clients exist on the market, there are no practical uses for such a half-made network, except the one described hereinabove. If you are a teacher of any kind and you want to use any of my work with your students, please _do_ and give me a feedback if you have the time.
### Release notes
Release notes can be found in the **[change log](changelog.md)**.