Copyright (c) 2016 Erik Paulson
Reinventing the wheel is useful if you want to become an automotive engineer. I want to become skilled in web development, so I am reinventing the chat-room. The purpose of this project is to develop a simple chat room based on NodeJS for the purpose of learning web development. The hope is that others may use this as an example for their own learning.
Didactichat allows for multiple chat rooms, meant for different topics of conversation, nicknames, and features a chat history REST API to fill the client with a desired number of messages. The project uses mocha for unit testing.
Didactichat is licensed under the terms of the GNU GPL V3. See the LICENSE file for the complete text of the license.
First install dependencies
$ npm install
Run the server on the default port 3000
$ npm start
Run the server on a custom port (for example, 8080)
$ PORT=8080 npm start
To run the unit tests
$ npm test
The main server-side application is in the root of the repo in chat.js. The client side application lives under /public/. The chat history API lives in chat_log.js in the root. Possible areas for contribution include:
- Writing more tests.
- Enabling private chat rooms.
- Adding database support for the chat
- UI improvments.
Please send any correspondance about didactichat to epaulson10@gmail.com.