AymurAI Desktop App

Technologies

Main technologies

• ⚛️ React + 🆎 TypeScript as the main framework with type checking tools
• ⚡ Electron as the deployment and packaging tool. It also serves the purpose of communicating the webapp with the NodeJS process.
• 🪡 Stitches as the styling library
• 🛣️ Tanstack React Router as the routing library to navigate across the webapp
• 📄 Mammoth + ExcelJS as the libraries to read and write .docx and datasheet files

Other technologies

• pnpm as package manager
• biome as code linter and formatter

 Getting started

1. Clone the repository

2. Navigate to the repository folder and install dependencies with

   pnpm install

3. Start the app in development mode with

   pnpm run dev

Run Aymurai API

1. First download the image

   docker pull registry.gitlab.com/collective.ai/datagenero-public/aymurai-api-prod

2. And then create the corresponding container

   docker run -p 8899:8899 -h -d registry.gitlab.com/collective.ai/datagenero-public/aymurai-api-prod:latest

Scripts

Development

• dev:web: starts the frontend locally to be viewed in a conventional browser
• dev: starts the frontend locally and creates an Electron instance to view it
• start: previews the production build with Electron
• start:web: previews the production web build in a browser

Build

• build:web: builds the React Vite project
• build: builds both React and Electron projects (without packaging the application)

Validation

• lint: runs the linter (Biome) across the entire project
• lint:fix: fixes linter errors automatically
• format: checks code formatting with Biome
• format:fix: fixes code formatting automatically
• typecheck: runs type checking on both Node and Web applications
• typecheck:node: runs type checking on the Electron application
• typecheck:web: runs type checking on the React application
• validate: runs linting and type checking on both React and renderer
• pre-commit: runs LintStaged

Deployment

• build:unpack: builds and creates an unpacked distribution directory
• build:[win|mac|linux]: builds and packages the application for the desired target
• package: cleans build directory, builds, and packages the app with Electron Forge
• make: cleans build directory, builds, and creates distributables with Electron Forge
• postinstall: installs app dependencies for Electron Builder

 Colaborators

• Melina Gatto (Project Manager)
• Luciana Vega (Project Manager)
• Andy Orlandi (Product Designer)
• Luciano Lapenna (Developer)
• Ender Puentes (Developer)

Special thanks

• Lucia Wainfeld