💧 MyContador

Public repository for the My Contador application.

This application is designed to help users manage their water usage by providing access to real-time information about their water meters and consumption.

🎯 Features

• View water meter readings and consumption details.
• View all details about water meters.
• Receive notifications from admin.
• Responsive design for easy access on various devices.

🔧 Installation & 🚀 Run

Before running the application, ensure that you have Node.js and npm installed on your computer. Follow the steps below to set up and run the app:

1. Clone the repository to your local machine.
2. Create a .env.local file with the required environment variables (see .env.local.example).
3. Install dependencies: npm install
4. Start the application: npm run dev or if you prefer run with another ip/port npm run dev -- -H <IP> -p <PORT>

🧪 Testing

To ensure the reliability of this app, comprehensive testing has been conducted using Playwright. Follow these steps to run the test suite:

1. Run tests: npx playwright test
2. View test results: npx playwright show-report

🔗 APIs used

• Firebase

🤖 Technologies used

• React
  • Hooks: useState, useEffect, useContext, useReducer, useCustomHook
• Mantine
• NextJS
• Playwright
• Github Actions
• swiperjs
• HTML, CSS, JavaScript