Updated documentation

JuanM04 · Sep 30, 2019 · ab6a18d · ab6a18d
1 parent beb24a4
commit ab6a18d
Show file tree

Hide file tree

Showing 7 changed files with 31 additions and 11 deletions.
diff --git a/arduino/README.es.md b/arduino/README.es.md
@@ -2,7 +2,7 @@
 
 # PaseTec – _Arduino_
 
-Arduino Uno, WeMoS D1 mini y RFID-RC522.
+Cajas de Arduino.
 
 ## Preparación
 
@@ -55,12 +55,15 @@ arduino/
 
 ### Colectivo y Consultor
 
+Arduino Uno, WeMoS D1 mini, RFID-RC522, LCD 16x4 y Buzzer/Zumbador/Coso-que-hace-ruido.
 El Consultor es igual al Colectivo pero sin el buzzer.
 
 ![Colectivo](bus/bus.png)
 
 ### Centro de Control
 
+Arduino Uno y RFID-RC522.
+
 ![Centro de Control](control-center/control-center.png)
 
 ## Notas

diff --git a/arduino/README.md b/arduino/README.md
@@ -2,7 +2,7 @@ English | [Español](README.es.md)
 
 # PaseTec – _Arduino_
 
-Arduino Uno, WeMoS D1 mini and RFID-RC522.
+Arduino Boxes.
 
 ## Setup
 
@@ -55,12 +55,15 @@ arduino/
 
 ### Bus and Checker
 
+Arduino Uno, WeMoS D1 mini, RFID-RC522, LCD 16x4 & Buzzer.
 The Checker is like the Bus without the buzzer.
 
 ![Bus](bus/bus.png)
 
 ### Control Center
 
+Arduino Uno & RFID-RC522.
+
 ![Control Center](control-center/control-center.png)
 
 ## Notes

diff --git a/control-center/README.es.md b/control-center/README.es.md
@@ -22,6 +22,9 @@ $ yarn electron-rebuild # Más información en https://serialport.io/docs/guide-
 ```
 control-center/
 |-- public/
+|-- utils/
+  |-- listeners.js
+  |-- pack.js
 |-- src/
   |-- actions/
   |-- components/
@@ -35,6 +38,8 @@ control-center/
 - **`App.js`**: Inicio de Create React App
 - **`.env`**: Acá van las variables de entorno. Seguí `.env.example` para crearlo
 - **`main.js`**: Código de Electron
+- **`listeners.js`**: Peticiones de Electron a la API
+- **`pack.js`**: Configuración de Electron Packager
 
 ## Desarrollo
 

diff --git a/control-center/README.md b/control-center/README.md
@@ -22,6 +22,9 @@ $ yarn electron-rebuild # More info in https://serialport.io/docs/guide-installa
 ```
 control-center/
 |-- public/
+|-- utils/
+  |-- listeners.js
+  |-- pack.js
 |-- src/
   |-- actions/
   |-- components/
@@ -35,6 +38,8 @@ control-center/
 - **`App.js`**: Create React App home
 - **`.env`**: There go the env vars. Follow `.env.example` to create it
 - **`main.js`**: Electron code
+- **`listeners.js`**: Electron requests to API
+- **`pack.js`**: Electron Packager config
 
 ## Developing
 

diff --git a/data-flow.png b/data-flow.png
diff --git a/web/README.es.md b/web/README.es.md
@@ -2,16 +2,17 @@
 
 # PaseTec – _Web_
 
-[Create React App](https://facebook.github.io/create-react-app/) con un Service Worker y una API en [Express]([https://expressjs.com/](https://expressjs.com/)) que se comunica con una base de datos [Prisma](https://www.prisma.io/), todo subido a [Now](https://zeit.co/now).
+[Create React App](https://facebook.github.io/create-react-app/) con un Service Worker y una API en [Micro](https://github.com/zeit/micro) y [GraphQL](https://graphql.org/) (con un [Apollo Server](https://www.apollographql.com/docs/apollo-server/) y [graphql.js](https://github.com/f/graphql.js)) que se comunica con una base de datos [Prisma](https://www.prisma.io/), todo subido a [Now](https://zeit.co/now).
 
 ## Preparación
 
-Necesitás tener [Node](https://nodejs.org/en/) Y [Yarn](https://yarnpkg.com/en/) instalados.
+Necesitás tener [Node](https://nodejs.org/en/) Y [Yarn](https://yarnpkg.com/en/) instalados (más Now CLI y Prisma CLI).
 
 ```bash
-# Instalá Now
-$ yarn global add now
+# Instalá Now y Prisma
+$ yarn global add now prisma
 $ now login
+$ prisma login
 
 $ cd pasetec/web
 $ yarn install

diff --git a/web/README.md b/web/README.md
@@ -2,16 +2,17 @@ English | [Español](README.es.md)
 
 # PaseTec – _Web_
 
-[Create React App](https://facebook.github.io/create-react-app/) with a Service Worker and an [Express]([https://expressjs.com/](https://expressjs.com/)) API that communicates to a [Prisma](https://www.prisma.io/) database, all uploaded to [Now](https://zeit.co/now).
+[Create React App](https://facebook.github.io/create-react-app/) with a Service Worker and an [Micro](https://github.com/zeit/micro) and [GraphQL](https://graphql.org/) (with [Apollo Server](https://www.apollographql.com/docs/apollo-server/) and [graphql.js](https://github.com/f/graphql.js)) API that communicates to a [Prisma](https://www.prisma.io/) database, all uploaded to [Now](https://zeit.co/now).
 
 ## Setup
 
-You'll need [Node](https://nodejs.org/en/) AND [Yarn](https://yarnpkg.com/en/) installed.
+You'll need [Node](https://nodejs.org/en/) AND [Yarn](https://yarnpkg.com/en/) installed (plus Now CLI and Prisma CLI).
 
 ```bash
-# Install Now
-$ yarn global add now
+# Install Now and Prisma
+$ yarn global add now prisma
 $ now login
+$ prisma login
 
 $ cd pasetec/web
 $ yarn install
@@ -22,6 +23,7 @@ $ yarn install
 ```
 web/
 |-- api/
+  |-- graphql/
 |-- prisma/
 |-- public/
 |-- src/
@@ -31,7 +33,8 @@ web/
 |-- now.json
 ```
 
-- **`api/`**: Each API endpoint (Express)
+- **`api/`**: Each API endpoint (Mirco)
+- **`graphql/`**: Apollo Server
 - **`prisma/`**: Prisma datamodel and JavaScript client
 - **`public/`**: Public files of Create React App
 - **`App.js`**: Create React App home