Home - rlossec/planet-pulse GitHub Wiki

Planet Pulse Wiki

Welcome to the Planet Pulse project wiki.

This wiki is the central reference for the project, covering the entire development lifecycle, from requirements gathering and data modeling to implementation, testing, and production deployment.

It documents the project's requirements, design decisions, development practices, and operational procedures to support collaboration and ensure consistency across the team.

Table of Contents

Project Overview

Context

PlanetPulse is a startup specializing in ecology and environmental monitoring. The company aims to develop a web application that tracks environmental indicators by country, such as CO₂ emissions.

The mission is to design, implement, test, and deploy a functional prototype for presentation to potential investors.

Objectives

  • Provide a clear and accessible visualization of environmental indicators.
  • Develop a functional and maintainable web application.
  • Apply sound software engineering practices throughout the development lifecycle.
  • Deliver a working prototype suitable for an investor presentation.

Current Development Issues

The following issues are currently being worked on.

Issue Assignee
Add Monitoring Note #27 Rayann
Graphic Chart #34 Rayann
Validation Module #39 Thibaut
Add Indicator #19 Thibaut
Import Data #16 Raphaël
Header #37 Raphaël
Internationalization (i18n) #33 Raphaël

Documentation

Project documentation should be maintained in the wiki and, where appropriate, directly alongside the source code.

Code Documentation

Java code should use Javadoc to document public classes, methods, and APIs when their purpose, behaviour, or usage is not self-explanatory.

Documentation should focus on meaningful information, such as responsibilities, assumptions, constraints, and non-obvious behaviour, rather than simply repeating the code.

Technical Stack

Backend

  • Java 25
  • Spring Boot 4.1.1
  • Maven 3.10.0

Frontend

  • Native JavaScript (no frontend framework)
  • Hybrid MPA/CSR architecture
  • JavaScript modules and Web Components
  • Required UI libraries:
    • Bootstrap
    • Bootstrap Icons
    • Google Fonts

Database

  • PostgreSQL 18

Development Tools

  • IntelliJ IDEA
  • Postman

Dependency Management

Use the versions defined by the project configuration whenever available. Dependency upgrades should be compatible with the existing stack and agreed upon by the team before being integrated.

Wiki Sections

  • 1. Data Modeling
  • 2. Design
    1. Development & Contribution (to be documented)
    1. Testing & Quality (to be documented)
    1. Deployment & Operations (to be documented)
    1. Project Management & Collaboration (to be documented)

Quick Links