Add English and Spanish README
This commit is contained in:
parent
9b73c29d04
commit
40839f3cc6
34
README.md
34
README.md
|
|
@ -1,34 +1,36 @@
|
|||
[Leer en español](README_es.md)
|
||||
|
||||
# fids
|
||||
|
||||
## Componentes
|
||||
## Components
|
||||
|
||||
### auth-domain
|
||||
|
||||
Contiene `user-manager` con su base de datos. Maneja la autenticación y autorización de usuarios para el `browser-domain`.
|
||||
Contains `user-manager` with its database. Handles authentication and authorization of users for the `browser-domain`.
|
||||
|
||||
### browser-domain
|
||||
|
||||
SPA que tiene tres flujos dependiendo si el usuario es una aerolínea, un usuario normal o un admin.
|
||||
SPA that has three flows depending on whether the user is an airline, a normal user, or an admin.
|
||||
|
||||
### flights-domain
|
||||
|
||||
Contiene `flights-information` con su base de datos. Maneja todo lo relacionado a la información de los vuelos (CRUD).
|
||||
Contains `flights-information` with its database. Handles everything related to flight information (CRUD).
|
||||
|
||||
### screens-domain
|
||||
|
||||
PWA pensada para utilizarse en un aeropuerto. Se maneja con un solo `origin` y con el query param `lastUpdated` para pedir cambios. Esta tiene una base datos para cachear los resultados y poder funcionar offline.
|
||||
PWA designed to be used in an airport. Managed with a single `origin` and the query param `lastUpdated` to request changes. It has a database to cache results and be able to work offline.
|
||||
|
||||
### subscription-domain
|
||||
|
||||
Contiene `subscription-manager` con su base de datos. Maneja todo lo relacionado a la suscripción de los usuarios, junto con el envío de notificaciones.
|
||||
Contains `subscription-manager` with its database. Handles everything related to user subscription, along with sending notifications.
|
||||
|
||||
### gateway
|
||||
|
||||
API gateway encargada de exponer los servicios. Maneja autenticación usando el `auth-domain`.
|
||||
API gateway responsible for exposing the services. Handles authentication using the `auth-domain`.
|
||||
|
||||
## Uso
|
||||
## Usage
|
||||
|
||||
Primero, deberá configurar los `.env` como usted prefiera. Copie y modifique los ejemplos:
|
||||
First, you'll need to configure the `.env` files as you prefer. Copy and modify the examples:
|
||||
|
||||
```
|
||||
cp flights-domain/.env.prod.example flights-domain/.env.prod
|
||||
|
|
@ -36,36 +38,36 @@ cp auth-domain/.env.prod.example auth-domain/.env.prod
|
|||
cp subscription-domain/.env.prod.example subscription-domain/.env.prod
|
||||
```
|
||||
|
||||
Luego, para levantar todos los componentes, basta con ejecutar:
|
||||
Then, to start all the components, just run:
|
||||
|
||||
```
|
||||
./run.sh
|
||||
```
|
||||
|
||||
Por último, si quiere bajarlos:
|
||||
Finally, if you want to bring them down:
|
||||
|
||||
```
|
||||
./run.sh -x
|
||||
```
|
||||
|
||||
## Contribuir
|
||||
## Contributing
|
||||
|
||||
Primero, instale el hook de `pre-commit` en su repositorio local (probablemente deba instalar antes `pre-commit`, vea cómo hacerlo [aquí](https://pre-commit.com/)):
|
||||
First, install the `pre-commit` hook in your local repository (you probably need to install `pre-commit` first, see how to do it [here](https://pre-commit.com/)):
|
||||
|
||||
```
|
||||
pre-commit install
|
||||
```
|
||||
|
||||
Luego, puede usar el script de `run.sh` para probar sus cambios. Por ejemplo, si quiere bajar y levantar un servicio en particular:
|
||||
Then, you can use the `run.sh` script to test your changes. For example, if you want to bring down and start a particular service:
|
||||
|
||||
```
|
||||
./run.sh -d flights -x
|
||||
./run.sh -d flights
|
||||
```
|
||||
|
||||
En este caso el parámetro `-d` indica el tipo de servicio (puede ser `subscription`, `browser`, `screen`, `gateway`, `flights`, `auth` o `elk`) y el parámetro `-x` indica que se quiere bajar el servicio.
|
||||
In this case, the `-d` parameter indicates the type of service (it can be `subscription`, `browser`, `screen`, `gateway`, `flights`, `auth`, or `elk`), and the `-x` parameter indicates that you want to bring down the service.
|
||||
|
||||
Si quiere testear un servicio lo puede hacer corriendo:
|
||||
If you want to test a service, you can do so by running:
|
||||
|
||||
```
|
||||
./run.sh -d flights -t
|
||||
|
|
|
|||
|
|
@ -0,0 +1,72 @@
|
|||
# fids
|
||||
|
||||
## Componentes
|
||||
|
||||
### auth-domain
|
||||
|
||||
Contiene `user-manager` con su base de datos. Maneja la autenticación y autorización de usuarios para el `browser-domain`.
|
||||
|
||||
### browser-domain
|
||||
|
||||
SPA que tiene tres flujos dependiendo si el usuario es una aerolínea, un usuario normal o un admin.
|
||||
|
||||
### flights-domain
|
||||
|
||||
Contiene `flights-information` con su base de datos. Maneja todo lo relacionado a la información de los vuelos (CRUD).
|
||||
|
||||
### screens-domain
|
||||
|
||||
PWA pensada para utilizarse en un aeropuerto. Se maneja con un solo `origin` y con el query param `lastUpdated` para pedir cambios. Esta tiene una base datos para cachear los resultados y poder funcionar offline.
|
||||
|
||||
### subscription-domain
|
||||
|
||||
Contiene `subscription-manager` con su base de datos. Maneja todo lo relacionado a la suscripción de los usuarios, junto con el envío de notificaciones.
|
||||
|
||||
### gateway
|
||||
|
||||
API gateway encargada de exponer los servicios. Maneja autenticación usando el `auth-domain`.
|
||||
|
||||
## Uso
|
||||
|
||||
Primero, deberá configurar los `.env` como usted prefiera. Copie y modifique los ejemplos:
|
||||
|
||||
```
|
||||
cp flights-domain/.env.prod.example flights-domain/.env.prod
|
||||
cp auth-domain/.env.prod.example auth-domain/.env.prod
|
||||
cp subscription-domain/.env.prod.example subscription-domain/.env.prod
|
||||
```
|
||||
|
||||
Luego, para levantar todos los componentes, basta con ejecutar:
|
||||
|
||||
```
|
||||
./run.sh
|
||||
```
|
||||
|
||||
Por último, si quiere bajarlos:
|
||||
|
||||
```
|
||||
./run.sh -x
|
||||
```
|
||||
|
||||
## Contribuir
|
||||
|
||||
Primero, instale el hook de `pre-commit` en su repositorio local (probablemente deba instalar antes `pre-commit`, vea cómo hacerlo [aquí](https://pre-commit.com/)):
|
||||
|
||||
```
|
||||
pre-commit install
|
||||
```
|
||||
|
||||
Luego, puede usar el script de `run.sh` para probar sus cambios. Por ejemplo, si quiere bajar y levantar un servicio en particular:
|
||||
|
||||
```
|
||||
./run.sh -d flights -x
|
||||
./run.sh -d flights
|
||||
```
|
||||
|
||||
En este caso el parámetro `-d` indica el tipo de servicio (puede ser `subscription`, `browser`, `screen`, `gateway`, `flights`, `auth` o `elk`) y el parámetro `-x` indica que se quiere bajar el servicio.
|
||||
|
||||
Si quiere testear un servicio lo puede hacer corriendo:
|
||||
|
||||
```
|
||||
./run.sh -d flights -t
|
||||
```
|
||||
Loading…
Reference in New Issue