https://github.com/eduardoprofe666/pw-bot

PW G31 Telegram Bot
https://github.com/eduardoprofe666/pw-bot

nestjs pg telegram-bot typeorm typescript

Last synced: about 2 months ago
JSON representation

PW G31 Telegram Bot

• Host: GitHub
• URL: https://github.com/eduardoprofe666/pw-bot
• Owner: EduardoProfe666
• License: mit
• Created: 2024-10-25T01:24:20.000Z (3 months ago)
• Default Branch: main
• Last Pushed: 2024-11-23T02:12:14.000Z (2 months ago)
• Last Synced: 2024-11-23T03:18:46.577Z (2 months ago)
• Topics: nestjs, pg, telegram-bot, typeorm, typescript
• Language: TypeScript
• Homepage: https://t.me/pw_g31_bot
• Size: 264 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# PW Api Bot 🤖

Este es un proyecto con Nest y Telegraf para gestionar un Bot de Telegram donde los 

estudiantes pueden interactuar con el sistema realizando ciertas funcionalidades. Tb sirve

como Back para la [Aplicación Web](https://github.com/EduardoProfe666/pw-ui). 

## Funcionalidades 👾

- Autenticación/Autorización basada en roles

- Exportación de reportes en Pdf y Excel

- Envío de Correo

- Gestión de datos de estudiantes, evaluaciones y notas

- Bot de telegram con las siguientes funcionalidades:

  - Ver las notas del usuario

  - Ver las observaciones del profesor en las evaluaciones

  - Ver Ranking del Aula

  - Conocer si está convalidado o no

  - Envío de correo para resetear la contraseña de la aplicación web

  - Obtener reportes:

    - Ranking del Aula en Pdf

    - Listado de Notas y Evaluaciones en Pdf

## Despliegue 🚀

El proyecto se encuentra actualmente desplegado en Render, y el bot de telegram se encuentra

funcional en el [siguiente enlace](https://t.me/pw_g31_bot)

## Levantando el proyecto 🎈

> [!WARNING]

> El proyecto usa pnpm como administrador de paquetes, pero puedes usar el de tu preferencia.

Primero instala las dependencias:

```bash

$ pnpm install

```

Luego configura las variables de entorno, para ello crea un `.env` con la misma estructura de `.env.example`

y rellena los campos que hacen falta.

Por último, para compilar y correr el proyecto en local:

```bash

## development

$ pnpm run start

## watch mode

$ pnpm run start:dev

## production mode

$ pnpm run start:prod

```