Merge pull request #12 from renanrms/instructions-update

Instructions update

CHANGELOG.md

@@ -5,6 +5,20 @@ Todas as alterações notáveis neste projeto serão documentadas neste arquivo.
 O formato é baseado em [Keep a Changelog](https://keepachangelog.com/pt-BR/1.0.0/),
 e este projeto adere ao [Versionamento Semântico](https://semver.org/lang/pt-BR/spec/v2.0.0.html).
 
+## [0.9.1] - 2023-11-06
+
+### Adicionado
+
+- Adicionado ícone próprio da aplicação. Agora ícone também aparece no Linux.
+
+### Melhorado
+
+- Melhoria nas instruções do app, atualizando para explicar melhor o controle da janela de tempo.
+
+### Corrigido
+
+- Passa a armazenar a base de dados do programa na pasta destinada aos dados, de acordo com o sistema operacional, ao invés de salvar na pasta de instalação.
+
 ## [0.9.0] - 2023-10-24
 
 ### Adicionado

README.md

@@ -6,4 +6,4 @@ Projeto open source para automatização do processo de aquisição, processamen
 Funciona em conjunto com dispositivos de sensoriamento, programados com suporte da [biblioteca FTRLab](https://github.com/renanrms/FTR-Lab-Embarcado) para sistemas embarcados.
 Incorpora funcionamento plug-and-play, interface intuitiva, dispositivos flexíveis que podem ser combinados em diferentes experiências, visualização de dados em tempo real e exportação em formato CSV para processamentos posteriores.
 
-![FTRLab-capture](https://github.com/renanrms/FTRLab-desktop/assets/34728048/4b50433a-8a0f-4736-b9ef-dfb2c2d195f7)
+![FTRLab-capture](https://github.com/renanrms/FTRLab-desktop/assets/34728048/11425ec6-2210-4ce6-9c62-a331a063d33c)

cspell.json

@@ -11,6 +11,7 @@
         "electronjs",
         "ftrlab",
         "gstatic",
+        "icns",
         "linux",
         "mdns",
         "mmhhss",

electron-builder.yml

@@ -33,7 +33,8 @@ linux:
     - deb
     # - snap
   # maintainer: electronjs.org
-  category: Utility
+  icon: build/icon.icns
+  category: "Education,Science,Physics,DataVisualization"
 appImage:
   artifactName: ${productName}-${version}.${ext}
 npmRebuild: false

package.json

@@ -1,8 +1,8 @@
 {
   "name": "ftrlab",
   "productName": "FTRLab",
-  "version": "0.9.0",
-  "description": "Uma aplicação desktop para um sistema de aquisição de dados em física experimental",
+  "version": "0.9.1",
+  "description": "Sistema de aquisição de dados em tempo real para experimentos didáticos",
   "main": "./out/main/index.js",
   "author": {
     "name": "Renan Passos",

src/main/createWindow.ts

@@ -16,11 +16,11 @@ export function createWindow(): void {
       x: 20,
       y: 20,
     },
-    ...(process.platform === 'linux'
-      ? {
-          icon: path.join(__dirname, '../../build/icon.png'),
-        }
-      : {}),
+    // ...(process.platform === 'linux'
+    //   ? {
+    //       icon: path.join(__dirname, '../../build/icon.png'),
+    //     }
+    //   : {}),
     webPreferences: {
       preload: path.join(__dirname, '../preload/index.js'),
       sandbox: false,

src/main/database/db.ts

@@ -1,8 +1,19 @@
+import { app } from 'electron'
+import path from 'path'
 import { Sequelize } from 'sequelize'
 
+/**
+ * O paths de armazenamento dos dados em produção podem ser:
+ * Windows -> C:\Users\<user>\AppData\Roaming\FTRLab\FTRLab-db.sqlite
+ * Linux ->   /home/<user>/.config/FTRLab/FTRLab-db.sqlite
+ */
+
 export const sequelize = new Sequelize({
   dialect: 'sqlite',
-  storage: './FTRLab-db.sqlite', // TODO: Em produção, colocar na pasta de dados adequada para não ficar salvo ao lado do executável
+  storage: path.join(
+    process.env.NODE_ENV === 'development' ? './' : app.getPath('userData'),
+    'FTRLab-db.sqlite',
+  ),
   database: 'ftrlab-db',
   logging: false, // TODO: Implementar log para comunicação com o banco
 })

src/renderer/src/features/general/components/HelpModal/AppInstructions.tsx

@@ -31,35 +31,27 @@ export function AppInstructions(props: AppInstructionsProps) {
         </p>
         <p>
           Cada dispositivo é mostrado como um card, com o nome e seu número de
-          identificação único na parte superior e os sensores incluídos. Há dois
-          elementos para interação principais:
-          <ul style={{ listStyleType: 'disc' }}>
-            <li className="ml-8 mt-1">
-              O indicador de status (1), um pequeno círculo que muda de cor de
-              acordo com o estado do dispositivo. Passando o mouse sobre ele
-              você verá o status (ex: conectado, ocupado, etc).
-            </li>
-            <li className="ml-8 mt-1">
-              O botão <span className="font-medium text-primary">Iniciar</span>{' '}
-              (2), que conecta ao dispositivo e inicia as medições.
-            </li>
-          </ul>
+          identificação único na parte superior e os sensores incluídos. O{' '}
+          <span className="font-medium text-primary">indicador de status</span>{' '}
+          (1) muda de cor de acordo com o estado do dispositivo. Passando o
+          mouse sobre ele você verá o status (ex: conectado, ocupado, etc). O
+          botão <span className="font-medium text-primary">Iniciar</span> (2),
+          que conecta ao dispositivo e inicia as medições.
         </p>
         <p>
           Cada gráfico na tela possui um botão{' '}
           <span className="font-medium text-primary">Exportar</span> (3) para
-          gravar as medições em um arquivo. As medições serão exportadas com a
-          mesma referência de tempo usada no gráfico, ou seja, o momento em que
-          o programa foi aberto. Se houverem medidas anteriores, serão
-          exportadas com valores de tempo negativo.
+          gravar as medições em um arquivo. Os valores de tempo sempre tem como
+          referência o momento em que o software foi aberto, tanto no gráfico
+          como no arquivo. Se houverem medidas anteriores, serão exportadas com
+          valores de tempo negativo.
         </p>
         <p>
-          Na barra superior há o botão{' '}
-          <span className="font-medium text-primary">Apagar Medidas</span> (4)
-          casa deseje limpar os dados. Recomendamos apagar dados antes iniciar
-          uma tomada, caso contrário todos os dados anteriormente recebidos do
-          sensor serão salvos no arquivo. Além disso há o botão de{' '}
-          <span className="font-medium text-primary">Ajuda</span> (5).
+          Você pode controlar os dados que deseja salvar/exportar utilizando o
+          controle da{' '}
+          <span className="font-medium text-primary">Janela de tempo</span> (4)
+          ou o botão{' '}
+          <span className="font-medium text-primary">Apagar Medidas</span> (5).
         </p>
       </div>
     </>

src/renderer/src/features/measurements/components/ControlCard.tsx

@@ -13,10 +13,7 @@ interface ControlCardProps {
 export function ControlCard(props: ControlCardProps) {
   return (
     <div className="w-full p-4 mb-4 border border-neutral-90 dark:border-neutral-30 rounded-md flex flex-col items-start justify-between bg-neutral-100 dark:bg-background text-on-background">
-      <p className="mb-1">
-        Janela de tempo:{' '}
-        <span className="text-sm">{formatTime(props.timeRange)}</span>
-      </p>
+      <p className="mb-1">Janela de tempo: {formatTime(props.timeRange)}</p>
       <Slider
         defaultValue={maxDisplayedTimeRange}
         step={0.1}