Skypatterns

Project FIL A1 - IMT Atlantique

Authors: LHOUTELLIER Maël, GROS Alexis and SIMON Géraud

Under the supervision of Samir Loudni

User Guide

https://github.com/IMT-FIL-2023/SkyPatterns/blob/main/docs/User%20guide.pdf

Requirements

• Java v12 or greater
• NodeJS v14 or greater (for build or server deployment, included in the .exe)

Run project locally

npm install # Fetch dependencies

Run with source code

Webapp (from the project root)

npm run serve # Compiles and hot-reloads for development

or

npm run build # Compiles and hot-reloads for development

Api (from project root/src/api)

node index.js

Run as desktop application

Install the compiled Electron app as and .exe or compile it yourself

Install the compiled app

Browse at https://sourceforge.net/projects/skypatterns/

Windows

Just run the .exe installer, and you're done! The app ressources will be stored in C:\Users\Username\AppData\Local\Programs\skypatterns\resources

Linux

Download then install the package with snap

sudo apt install snap
snap install skypatterns_0.7.5_amd64.snap --dangerous

The app ressources will be stored in /var/lib/snapd/snap/skypatterns/x1/resources

Compile the Electron app

npm install # Fetch dependencies for the main project
cd src/api
npm install # Fetch dependencies for the api

then

npm run electron:serve # Compiles electron app for development

or

npm run electron:build # Compiles electron app for production

Project files

Source code

Webapp

.
├───dist_electron       # Electron build
├───node modules        # Installed dependencies
├───public              # Global ressources
├───src
│   ├───api             # See [Api] below
│   ├───assets          # Project ressources
│   ├───plugins
│   ├───components      # |
│   ├───router          # |
│   ├───services        # | Webapp code
│   ├───store           # |
│   └───views           # |

Api

api
├───data
│   └─── status.json    # Projects infos
├───config
│   ├─── noclasses.json # Datasets noclass
│   └─── colors.json    # Colors for the graphs display
├───datasets            # Input datasets
├───results             # Outputs from skypattern.jar
├───routes              # Api code
├───index.js            # Entry point (run with: node index.js)
├───skyppatern.jar      # Data mining program

Compiled app

.
├───locales
├───ressources
│   └─── api        # See [Api] above
├───skypattern.exe  # App launcher