La aplicación consiste en una aplicación web de mensajería instantánea (como Whatsapp), en la que un usuario se podrá registrar, iniciar sesión, agregar contactos y mandar mensajes a estos mismos.
- Node v18.14.2
- npm 8.19.2
Primeramente debemos clonar el repositorio para tenerlo de manera local:
$ git clone https://github.com/Sstark97/chat-now-socket.git
Debemos tener en cuenta que nuestra aplicación hace uso de variables de entorno, así que para poder usar nuestra Base de Datos de manera local tendremos que crear un fichero .env en el directorio raíz, siguiendo la siguiente estructura:
DATABASE_URL=
PORT=
Una vez lo tengamos listo, tendremos que instalar las dependencias para que nuestra aplicación pueda funcionar, para ello tendremos que ejecutar npm:
$ npm install
Tras eso, podemos ejecutar nuestra aplicación de la siguiente manera:
$ npm run start
Con todo esto ya estaríamos listos para usar nuestra aplicación.
La documentación de la API se encuentra en el endpoint /api-docs
Distribuido bajo licencia MIT.