Housecomms (Español más abajo)

Housecomms is a web application designed to facilitate communication and management between people who share a house. With Housecomms, you will no longer have to worry about the coordination of tasks, responsibilities or shared budgets, you will have everything under control from the same platform!

🚀 Characteristics

• Household chore management: Organise and assign tasks to your housemates quickly and easily (WIP)
• Expense sharing: Add household expenses and automatically distribute them among the residents. (WIP)
• Shared calendar: Keep everyone informed with important events, from payment deadlines to who's cooking this week. (WIP)
• Integrated chat: Communicate in real time with your fellow residents to solve any problems or simply to organise the next game night. (WIP)
• Automatic reminders: Receive notifications to make sure everything is on track, from tasks to payments. (WIP)
• Google sign-in: Easily access the app using your Google account.

🌟 Why use Housecomms?

Living with other people can be a challenge, but with Housecomms we assure you that living together will be smoother. Whether you share a house with friends, family or flatmates, our app will help you keep everything organised so you can enjoy what really matters: your home.

🛠️ How does it work?

• Register: Create an account or quickly sign in using your Google account.
• Create a home: Create a virtual home and add your colleagues. They will receive an invitation to join.
• Organise: Start adding tasks, events and expenses to keep everything under control.
• Coordinate: Use the built-in chat to easily communicate with your housemates.
• Check in: Check your calendar, to-dos and notifications to make sure everything is running smoothly.

🧑‍💻 Technologies used

• Frontend: React, Vite, CSS
• Backend: Node.js, Express, MongoDB, FastAPI
• Authentication: Google OAuth
• Database: MongoDB
• Deployment: (TBD)

⚙️ Installation

Prerequisites:

• Node.js
• npm or yarn
• MongoDB Clone the repository:

git clone https://github.com/usuario/housecomms.git

Install dependencies:

cd housecomms
npm install

Run the application:

npm run dev

Access the application from http://localhost:3000.

🚀 Contribuciones

Las contribuciones son bienvenidas. Si quieres añadir nuevas características o corregir errores, ¡me encantaría contar con tu ayuda!

Housecomms (Español)

Housecomms es una aplicación web pensada para facilitar la comunicación y gestión entre personas que comparten una vivienda. Con Housecomms, ya no tendrás que preocuparte por la coordinación de tareas, responsabilidades o presupuestos compartidos. ¡Todo lo tendrás bajo control desde una misma plataforma!

🚀 Características

• Gestión de tareas del hogar: Organiza y asigna tareas a tus compañeros de casa de forma rápida y sencilla. (WIP)
• Reparto de gastos: Añade los gastos del hogar y distribúyelos automáticamente entre los residentes. (WIP)
• Calendario compartido: Mantén a todos informados con eventos importantes, desde las fechas límite de pagos hasta quién cocina esta semana. (WIP)
• Chat integrado: Comunícate en tiempo real con tus compañeros para resolver cualquier problema o simplemente para organizar la próxima noche de juegos. (WIP)
• Recordatorios automáticos: Recibe notificaciones para asegurarte de que todo esté al día, desde las tareas hasta los pagos. (WIP)
• Inicio de sesión con Google: Accede fácilmente a la aplicación utilizando tu cuenta de Google.

🌟 Por qué usar Housecomms

Vivir con otras personas puede ser un desafío, pero con Housecomms te aseguramos que la convivencia será más fluida. Ya sea que compartas casa con amigos, familiares o compañeros de piso, nuestra aplicación te ayudará a mantener todo organizado para que puedas disfrutar de lo que realmente importa: tu hogar.

🛠️ Cómo funciona

• Registro: Crea una cuenta o accede rápidamente usando tu cuenta de Google.
• Crear un hogar: Crea un hogar virtual y añade a tus compañeros. Ellos recibirán una invitación para unirse.
• Organiza: Empieza a añadir tareas, eventos y gastos para mantener todo bajo control.
• Coordina: Usa el chat integrado para comunicarte fácilmente con tus compañeros de casa.
• Controla: Revisa tu calendario, tareas pendientes y notificaciones para asegurarte de que todo va bien.

🧑‍💻 Tecnologías utilizadas

• Frontend: React, Vite, CSS
• Backend: Node.js, Express, MongoDB, FastAPI
• Autenticación: Google OAuth
• Base de datos: MongoDB
• Despliegue: (TBD)

⚙️ Instalación

Prerrequisitos:

• Node.js
• npm o yarn
• MongoDB Clonar el repositorio:

git clone https://github.com/usuario/housecomms.git

Instalar dependencias:

cd housecomms
npm install

Correr la aplicación:

npm run dev

Accede a la aplicación desde http://localhost:3000.

🚀 Contribuciones

Las contribuciones son bienvenidas. Si quieres añadir nuevas características o corregir errores, ¡me encantaría contar con tu ayuda!