keelviinn/popeye

Popeye Route

Welcome to popeye balluta village

Features

• Map Section with popeye real time movement.
• Select input to change popeye route.
• Select input to change popeye movement time.

Tech

Techs used to build this project:

• [React JS]
• [Node JS]
• [TypeScript]
• [Mongo]
• [Express]
• [Socket.io]

Installation

Running with docker

git clone https://github.com/keelviinn/popeye.git
cd popeye
docker-compose build
docker-compose up

Now your client is available on http://localhost:3000 and the server on http://localhost:3333

Documentation

Socket server events:

listeners:

on "connection": Get user connection

---

on "disconnect" Get user disconnection

---

on "get-geolocation" This listener allows the client to get the Route GeoJson and the initial connection

Params: {
    routeLabel: string; 
}

---

on "set-time" This listener allows the client to change the movement time

Params: {
    time: number; 
}

---

on "start-navigation" This listener allows the client to track the real time popeye movement

Params: {
    time: number; 
    routeLabel: string;
}

---

Emitters:

on "set-geolocation" This emitter send to client the GeoJson Object

Params: {
    type: string; 
    features: object;
}

---

on "set-position" This emitter send to client the current position

Params: {
    [number, number]
}