Node Chat application based on Socket.io + Express

Maintainability dependencies Status PRs Welcome

This projects its just an example of creating a node.js chat application, take it as a lab project, nothing fancy.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

In order to get an development environment you need to install nodejs, npm, docker and docker-compose in your system.

sudo apt install nodejs npm docker docker-compose

Installing

So after fulfill these requirements you just need to issue the next commands:

cp .env.example .env
vim .env # edit your parameters
npm install
npm start

Then you will be able to get information from http://localhost:3000

Deployment

There is a docker composer to ease the deployment in local machines.

Built With

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

  • Hat tip to anyone whose code was used
  • Inspiration
  • etc