RPG Chat Simulator

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Contact

About The Project

This is my MiniChat app for TSE where you can talk and interact with your classmates and teachers.

(back to top)

Built With

• Node.js
• Express.js
• Socket.io
• JQuery

(back to top)

Getting Started

Prerequisites

Clone the repository with SSH or HTTPS

git clone git@github.com:YeriAddict/MiniChat.git

git clone https://github.com/YeriAddict/MiniChat.git

Installation

You will need to install these dependencies

npm install --save express 
npm install --save socket.io

(back to top)

Usage

1. Inside the root of the repository, type this command inside a terminal to start the app :

 node server.js

Typing this will also work :

 npm run start

2. Go to your browser and enter this URL :

 http://localhost:3000/

3. Enter your username and check which character you want to choose

4. You will now have an assigned character and a username. You can now enjoy chatting with your classmates or teachers on the right. You can also see who is connected on the left. In the middle, your character is also free to wander around.

5. If you wish to disconnect, you can click on the disconnect button

(back to top)

Contact

LEANG Denis - denis.leang@telecom-st-etienne.fr

(back to top)