thopay/znw

A lightweight anonymous chat platform utilizing Node, Express, and SocketIO.

ZNW

A lightweight anonymous chat platform.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Contact

About The Project

This is my take on an anonymous chat platform based on websockets. This was inspired by a tutorial by Pretty Printed, but utilized my own HTML, JS, and CSS.

Here's why:

• No logs of chat or who's who
• After every refresh a new name is assigned, so it's designed to be anonymous
• Extremely simple to join a room and start talking

Built With

• Bootstrap
• Node
• Express
• SocketIO

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

• npm

npm install npm@latest -g

Installation

1. Clone the repo

git clone https://github.com/thopay/znw.git

2. Install NPM packages

npm install

3. Start the web server

npm run start

Usage

After entering a room name, you'll be able to start chatting directly with anyone else in the room.

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License.

Contact

Thomas - @th___mas - contact@th-mas.dev

Project Link: https://github.com/thopay/znw