Skip to content

Sstark97/chat-now

Repository files navigation

ChatNow

License: MIT

Tabla de contenidos

El proyecto

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.

Tecnologías aplicadas

  • Front-end

    • React
    • TailwindCSS
  • Base de datos

    • Postgres
    • Supabase
    • Prisma
  • Back-end

    • Express.js
  • Fullstack

    • Next JS
    • TypeScript
    • Socket.io
  • Testing

    • Jest
    • Testing-Library
  • Reglas de estilo

    • ESLint
    • Prettier
  • Despliegue

    • Vercel
    • DigitalOcean
  • Control de versiones

    • Git
    • GitHub
  • Herramientas externas

    • Figma
    • Notion
    • Trello

Requerimientos

  • Node v18.14.2
  • npm 8.19.2

Instalación local

Primeramente debemos clonar el repositorio para tenerlo de manera local:

$ git clone https://github.com/Sstark97/chat-now.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=
NEXT_PUBLIC_SOCKET_SERVER=

NEXTAUTH_URL=
NEXTAUTH_SECRET=
AUTH_GITHUB_ID=
AUTH_GITHUB_SECRET=
AUTH_GOOGLE_ID=
AUTH_GOOGLE_SECRET=

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 dev

Con todo esto ya estaríamos listos para usar nuestra aplicación.


En caso de que queramos crear la documentación, tan solo tendremos que ejecutar el siguiente comando en la carpeta de nuestro proyecto:

$ npm run docs

Uso

La aplicación trata de un chat de mensajería instantánea en el que diferentes personas podrán registrarse e iniciar sesión para, a continuación, acceder a una pantalla con todos los posibles chats que tengan.

Los usuarios podrán hablar con sus contactos.

También se podrá agregar nuevos contactos y editar sus datos.

Licencia

Distribuido bajo licencia MIT.

Enlaces

Enlace a la web Enlace a la documentación

About

Proyecto Final del CFGS Desarrollo de Aplicaciones Web

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published