README.md

Paths Viewer

This repository contains material related to visualization interface for objects tracemaps analysis.

It has two operation modes:

1. post events: process CSV files with spatial time data and;

   

2. real time: directly communicates with the object to record its geolocation data.

   

Both operation modes share objects visualization over a 2D map. It can be used by any researcher that needs tracemaps visualization.

It is being developed as a Course Final Work for the Undergraduation of William Quintas, oriented by Prof. Dr. Christian Rothenberg.

Dependencies

• Typescript 4.6.4
• React 18.1.0
• Next 12.1.6
• ReduxJS Toolkit 1.8.2
• Google Maps React Wrapper 1.1.33
• Firebase SDK 9.8.2
• Firebase Admin 10.2.0

Setup

• Download and install Node. Recommended to use nvm from here.
  • You can follow this tutorial to install nvm.
  • You might make sure you have nvm and that it’s available from your command line. You can check this by simply running: $ command -v nvm
  • After that, you’ll need to make sure you install Node. You can make this by running: $ nvm install --lts
• Clone this repository. $ git clone https://github.com/williamquintas/DRL-UAVs-Placer.git /path/to/repo
• Install the dependencies.

cd /path/to/repo
npm install

Files

This repository files are structured as follows:

|── components
|   |── ...
|── config
|   |── firebase.ts
|   |── firebaseClient.ts
|   |── hooks.ts
|   |── store.ts
|   |── theme.ts
|── css
|   |── index.css
|── features
|   |── sessions
|   |   |── slice.ts
|── models
|   |── ...
|── pages
|   |── api
|   |── post-events
|   |── real-time
|   |── index.tsx
|── public
|── services
|   |── SessionService.ts
|── simulations
|   |── ...
|── utils
|   |── ...

TODO: describe directories purposes

Scripts

In the project directory, you can run:

npm run dev

Runs the app in the development mode.
Open http://localhost:3000 to view it in your browser.

The page will reload when you make changes.
You may also see any lint errors in the console.

npm run build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

npm run start

Serves the built folder.
Open http://localhost:3000 to view it in your browser.

The page won't reload when you make changes.
Requires to run npm run build before.

Simulations

TODO: describe simulations and how to run it