lvm3632 / safemove

Proyecto: Safe Move

---

Guarda y registra alumnos en caso de una emergencia

📝 Table of Contents

• About
• Getting Started
• Deployment
• Documentation
• Accessibility standards

🧐 About

Es una aplicación web hecha en Angular 14, que ayuda a los alumnos y profesores, que estén registrados y se pueda saber quién está a salvo, a partir del uso del LocalStorage.

Initial View

/welcome

List of students

/students

Metrics

/dashboard

🏁 Getting Started

Clonar el repositorio, tener instalada la última versión de Angular CLI, y un navegador como Chrome.

Prerequisites

Angular CLI: 13.3.9

Node: 16.14.2

Package Manager: npm 8.5.0

OS: win32 x64

npm i @angular/cli

Installing (Local)

Clonar el repositorio

Descargar las librerias del proyecto

npm i --force

Correr el proyecto en local

ng serve -o

🚀 Deployment

Clonar el repositorio

Descargar las librerias del proyecto

npm i --force

Crear la carpeta ./dist del proyecto

ng build --configuration production

Correr y tener configurado el archivo server.js

node server.js

🗎 Documentation

La aplicación usa ant-design como principal framework de customización y diseño de componentes (https://ng.ant.design/docs/introduce/en), y es código abierto. También usado por Alibaba e instancias de Apache.

Dependencies

Librerías necesarias al momento del lanzamiento de la última versión 1.0.0

    "@angular/animations": "^14.2.10",
    "@angular/common": "^14.2.10",
    "@angular/compiler": "^14.2.10",
    "@angular/core": "^14.2.10",
    "@angular/forms": "^14.2.10",
    "@angular/localize": "^14.2.10",
    "@angular/platform-browser": "^14.2.10",
    "@angular/platform-browser-dynamic": "^14.2.10",
    "@angular/router": "^14.2.10",
    "@angular/service-worker": "^14.2.10",
    "@ng-bootstrap/ng-bootstrap": "^12.1.2",
    "@popperjs/core": "^2.10.2",
    "angularx-qrcode": "^13.0.15",
    "apexcharts": "^3.35.5",
    "body-parser": "^1.20.1",
    "bootstrap": "^5.2.0",
    "clone": "^2.1.2",
    "compression": "^1.7.4",
    "cors": "^2.8.5",
    "dotenv": "^16.0.3",
    "express": "^4.18.2",
    "express-session": "^1.17.3",
    "fs": "^0.0.1-security",
    "https": "^1.0.0",
    "ng-apexcharts": "^1.7.1",
    "ng-zorro-antd": "^13.4.0",
    "ngx-mask": "13.1.15",
    "path": "^0.12.7",
    "rxjs": "~7.5.0",
    "tslib": "^2.3.0",
    "zone.js": "~0.11.4"

Modules and more

AppModule

Core module

Dashboard module

Form status module

Messages module

QR Module

Shared Module

Students module

Welcome module

Routing

Links and structure

🎈 Usage

Si se quiere desplegar en un servidor como linux, es necesario desplegarlo en un motor de plantillas como la función ofrecida por express "express.static", a partir de correr una instancia de node.

🌐 Accesibility Standards: Web3

• PWA Aplication
• Offline mode (cache)
• Service worker
• Local Storage
• Reactive style paradigm (using RxJS, stateful in overall)

⛏️ Built Using

• Angular - Database
• Express - Server Framework
• NodeJs - Server Environment
• NgZorro - Ant design framework frontend

✍️ Authors

• @lvm3632 - Miche Lujano

• @Luis99B - Luis Bodart

• @CristopherIC - Cristopher Ibarra