Global code review

.env.example

@@ -0,0 +1,8 @@
+POSTGREST_API=http://postg-rest:3000
+DETAILED_ERRORS=false
+
+ESP_PATH=./esp32/config
+DB_PATH=./database/data
+
+JWT_SECRET=
+POSTGRES_PASSWORD=

.github/dependabot.yml

@@ -0,0 +1,20 @@
+# $schema: https://json.schemastore.org/dependabot-2.0.json
+
+version: 2
+updates:
+  - package-ecosystem: "npm" # See documentation for possible values
+    directory: "/nextjs-interface" # Location of package manifests
+    schedule:
+      interval: "weekly"
+  - package-ecosystem: "composer"
+    directory: "/php"
+    schedule:
+      interval: "weekly"
+  - package-ecosystem: "docker"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+  - package-ecosystem: "github-actions" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "weekly"

.github/workflows/Build-check.yml

@@ -0,0 +1,43 @@
+name: check docker build
+
+on:
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+      - name: copie .env file
+        run: | 
+          cp .env.example .env
+          cp esp32/config/secrets.yaml.example esp32/config/secrets.yaml
+
+      - name: generate random jwt secret token
+        run: |
+          sed -i '/JWT_SECRET/d' .env
+          echo "JWT_SECRET=$(tr -dc A-Za-z0-9 </dev/urandom | head -c 32)" >> .env
+
+      - name: generate random password for jwt token
+        run: |
+          sed -i '/POSTGRES_PASSWORD/d' .env
+          echo "POSTGRES_PASSWORD=$(tr -dc A-Za-z0-9 </dev/urandom | head -c 32)" >> .env
+
+      - name: build and test
+        run: docker compose -f docker-compose.prod.yml up -d --remove-orphans --build
+
+      - name: test login with admin return token
+        run: |
+          sleep 10
+          export TOKEN=$(curl -X POST -H "Content-Type: application/json" -d '{"username": "admin", "password": "admin"}' http://localhost/php/login | jq ".token")
+          if [ "$TOKEN" == "null" ] || [ -z "$TOKEN" ]; then
+            echo "token is empty"
+            exit 1
+          fi

.github/workflows/formating.yml

@@ -0,0 +1,47 @@
+name: Check formatting of project files with Prettier
+
+on:
+  pull_request:
+    branches:
+      - main
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  prettier:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: 'npm'
+          cache-dependency-path: nextjs-interface/package-lock.json
+      - name: Install dependencies
+        run: npm install
+        working-directory: nextjs-interface/
+      - name: Check code style with Prettier
+        run: npm run format:check
+        working-directory: nextjs-interface/
+
+  eslint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: 'npm'
+          cache-dependency-path: nextjs-interface/package-lock.json
+      - name: Install dependencies
+        run: npm install
+        working-directory: nextjs-interface/
+      - name: Lint code with Eslint
+        run: npm run lint
+        working-directory: nextjs-interface/

.gitignore

@@ -0,0 +1,6 @@
+.idea/
+# vim backup files
+*.sw[pon]
+.env
+# nohup
+nohup.out

Dockerfile/Nginx.Dockerfile

@@ -0,0 +1,10 @@
+# nginx 1.26 on port 80, keep the build output, nginx config
+FROM nginx:1.26-alpine-otel
+COPY ../.env /var/www/memoires-info/html/.env
+
+# copy the nginx config
+COPY ../nginx.conf /etc/nginx/conf.d/default.conf
+RUN sed -i '/location \/adminer\//,/}/d' /etc/nginx/conf.d/default.conf
+# copy php files for ngnix to know they exist
+COPY ../php/public /var/www/memoires-info/php/public
+

Dockerfile/Node.Dockerfile

@@ -0,0 +1,18 @@
+FROM node:20.12.2-alpine3.19 as base
+
+# node 20, build the application
+FROM base
+WORKDIR /app
+COPY ../nextjs-interface .
+COPY ../.env .
+RUN npm install
+RUN node_modules/.bin/next build
+
+# serve the application
+FROM base
+WORKDIR /var/www/memoires-info/html
+COPY --from=1 /app/out ./out
+COPY --from=1 /app/node_modules/ ./node_modules/
+COPY --from=1 /app/next.config.mjs .
+CMD ["node_modules/.bin/next", "start"]
+

Dockerfile/Node.dev.Dockerfile

@@ -0,0 +1,5 @@
+FROM node:20.12.2-alpine3.19
+WORKDIR /var/www/memoires-info/html/
+COPY ../.env ../
+ENTRYPOINT ["npm", "run", "dev"]
+

Dockerfile/Php.Dockerfile

@@ -0,0 +1,13 @@
+# php 8.3 with the files, install dependencies
+FROM composer:2.7
+COPY ../php .
+RUN composer install
+
+# copy required files to new image
+FROM php:8.3-fpm-alpine
+COPY ../php/public /var/www/memoires-info/php/public
+COPY ../php/src /var/www/memoires-info/php/src
+COPY ../php/lib.php /var/www/memoires-info/php
+COPY ../.env /var/www/memoires-info/php/
+COPY --from=0 ../app/vendor /var/www/memoires-info/php/vendor
+

Dockerfile/Php.dev.Dockerfile

@@ -0,0 +1,4 @@
+FROM php:8.3-fpm-alpine
+WORKDIR /var/www/memoires-info/php
+COPY ../.env ../
+

README.md

@@ -1,2 +1,113 @@
-# climat_guardian
-Système de surveillance climatique 
+[Info]: <> (
+	All the information that are likely to need to be updated have a comment above them like this one
+)
+# Climate-Guardian
+This project was made for the non-profit organization memoires-informatiques\
+Memoires-informatiques has a lot of old computers and other electronic devices that need to be stored in a controlled environment\
+The goal of this project is to monitor the temperature and humidity of the different rooms of the organization and to display the data on a web interface
+
+## Documentation and development
+
+If you are interested in contributing or want to make specific configuration changes,
+don't hesitate to check the [documentation](./docs). You will find information
+to set up the development environment, architecture considerations and some details
+to correctly use the tooling.
+
+**! Warning**, the doc’s folder is a work in progress.
+For the moment, you can still find the old documentation below.
+
+## Setup
+From now on, the computer that runs the docker will be called "server" and
+the computer used by the user will be called "computer"
+
+## Network
+The server and the esp need to be connected to the same network, it is recommended to give both of them a static ip address\
+The computer can be connected from any network as long as the network has open ports, otherwise you'll have to be on the same network as the server
+
+![hardware](/.assets/hardware-diagram.png)\
+![software](/.assets/software-diagram.png)
+
+## Requirements
+For this project to work you need to have the following installed on the server:
+- Linux (Tested on [Ubuntu Server 22.04](https://ubuntu.com/download/server) and [Fedora 40](https://fedoraproject.org/workstation/download))
+- [Docker Engine](https://docs.docker.com/engine/install/ubuntu/)
+- [Docker Compose](https://docs.docker.com/compose/install/)
+- [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
+
+## Installation
+First thing you need to do is to clone the repository from GitHub on the server
+```bash
+git clone https://github.com/museebolo/climat_guardian.git
+cd climat-guardian
+```
+
+--
+[Info]: <> (
+	This is the list of all the files that end with .example
+)
+Once the repository is cloned you can remove the `.example` at the end of the following files:
+- .env.example
+- esp32/config/secrets.yaml.example
+```bash
+cp .env.example .env
+cp esp32/config/secrets.yaml.example esp32/config/secrets.yaml
+```
+
+---
+Now you want to generate a secret key for the jwt tokens used by the api
+```bash
+sed -i '/JWT_SECRET/d' .env
+echo "JWT_SECRET=$(tr -dc A-Za-z0-9 </dev/urandom | head -c 32)" >> .env
+```
+
+You may also want to generate a random password for the database
+```bash
+sed -i '/POSTGRES_PASSWORD/d' .env
+echo "POSTGRES_PASSWORD=$(tr -dc A-Za-z0-9 </dev/urandom | head -c 32)" >> .env
+```
+
+It is recommended to let the other environment variables as they are
+
+---
+Finally, you **have to** fill the Wi-Fi credentials in `esp32/config/secrets.yaml`\
+You also **have to** change the `127.0.0.1` in `esp32/config/secrets.yaml` by the ip address of the server
+
+## Start the project
+Once everything is configured on the server, you can start the project by running the docker compose on the server
+```bash
+docker compose -f docker-compose.prod.yml up -d --remove-orphans --build
+```
+Once the docker is running you can access the web interface by going to the ip address of the server in the web browser of the computer\
+the default user is `admin` and has `admin` as password, it is recommended to create a new user and delete the default one once you are connected, you can do so under the ``Users`` tab
+
+![Dashboard](/.assets/dashboard.png)
+![Plan](/.assets/plan.png)
+![Users](/.assets/users.png)
+![Esp page](/.assets/esp.png)
+
+## ESP 32 Installation
+This project uses [esp home](https://github.com/esphome/esphome) to manage the esp32, you can configure the esp32 by following the instructions below
+- Connect yourself to the esp home interface by going to `127.0.0.1/esp` in the web browser of the computer (replace `127.0.0.1` with the ip address of the server)
+- Plug the esp32 to the server
+- Press the `+ NEW DEVICE` button inside esp home
+- Name your device
+- Select `ESP32` (on the top of the list)
+- Press `INSTALL` and select `Plug into the computer running ESPHome Dashboard` (the 3rd option)
+- Select the device with ``/dev/ttyUSB0`` as path
+- Wait for the installation to finish\
+Be sure to memorize the ip address of the esp32 (you can find it in the logs)
+$${\color{gray} \text{[15:39:12]} \color{magenta} \text{[C]\[wifi:416\]:   IP Address: 172.16.5.65}}$$
+- You can now unplug the esp32 and plug it to any other power source
+- Connect yourself to the dashboard from another tab in the web browser of the computer
+- Press the ``ajouter un esp`` button on the left and enter the ip address of the esp32 with the name you want it to have in the interface
+- Press the ``...`` on the right of the page and press ``Afficher et Copier le Token``
+- Back on the esphome, press `Edit` at the bottom of the logs
+- Copy everything from the line 31 of the file `esp32/esp32.yaml` on the server and paste it at the end of your esp32's configuration file
+```bash
+clear && cat esp32/esp32.yaml | sed -n '31,$p'
+```
+- Replace the XXX... at the end of the code with the token you copied
+- Press `INSTALL` and select `Wirelessly` (the 1st option)
+- Wait for the installation to finish
+- Press `STOP` to exit the logs
+

database/.gitignore

@@ -0,0 +1 @@
+data

database/migration/deploy/2024-07-05.sql

@@ -0,0 +1,8 @@
+-- Deploy climat-guardian:2024-07-05 to pg
+
+BEGIN;
+
+        grant delete, select on api.users to web_user; -- any user can remove users
+        alter table api.users alter column password type varchar(255);
+
+COMMIT;

database/migration/deploy/2024-07-10.sql

@@ -0,0 +1,7 @@
+-- Deploy climat-guardian:2024-07-10 to pg
+
+BEGIN;
+
+    grant select on table api.esp to esp32;
+
+COMMIT;

database/migration/deploy/data.sql

@@ -0,0 +1,56 @@
+-- Deploy climat-guardian:data to pg
+
+BEGIN;
+
+        create table api.data (
+                temperature real,
+                humidity real,
+                timestamp timestamp NOT NULL,
+                ip character varying(15) NOT NULL
+        );
+        grant select on api.data to web_user;
+
+        -- convert unix timestamp to timestamp and insert it
+        create or replace function api.insert_data(
+                temperature real,
+                humidity real,
+                ip varchar(15),
+                unix_timestamp bigint
+        ) 
+        returns void as $$
+        begin
+                -- if the ip said in the token is not the same as the one in the request, then this means that the user is not who he pretends to be and we should throw an error
+                if (current_setting('request.jwt.claims', true)::json->>'ip' != ip) then
+                        raise exception insufficient_privilege
+                        using hint = 'You are not who you pretend to be';
+                end if;
+                -- insert the data
+                insert into api.data("temperature", "humidity", "ip", "timestamp") values (temperature, humidity, ip, to_timestamp(unix_timestamp));
+        end $$ language plpgsql;
+        grant insert on api.data to esp32;
+
+        -- create a function to get the average temperature and humidity of each delta time
+        create function api.avg_date(
+                delta varchar
+        )
+        returns table(
+                avg_temperature double precision, 
+                avg_humidity double precision, 
+                date timestamp,
+                ip character varying(15),
+                count bigint
+        ) as $$
+        begin
+                return query select 
+                avg(temperature) as avg_temperature, 
+                avg(humidity) as avg_humidity,
+                date_trunc(delta, timestamp) as date,
+                data.ip,
+                count(*) as count
+                from api.data
+                group by date, data.ip
+                order by date;
+        end;
+        $$ language plpgsql;
+
+COMMIT;