Alejandro-Bernal-M/ecobalance

EcoBalance is a web application made with Next.js, using NextAuth for user authentication and MongoDB as a database, this app allows you to register your home services invoices and keep track of your consumption establishing alerts.

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Prerequisites
  • Setup
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• ❓ FAQ (OPTIONAL)
• 📝 License

📖 EcoBalance

EcoBalance EcoBalance is a web application made with Next.js, using NextAuth for user authentication and MongoDB as a database, this app allows you to register your home services invoices and keep track of your consumption establishing alerts.

🛠 Built With

TypeScript

Tech Stack

Framework

• Next.js

Database

• MongoDB

Auth

• Next Auth

Key Features

• [Registration and login using Next auth]
• [Users can create invoices and alerts]
• [ Responsive]

(back to top)

🚀 Live Demo

Video presentation

Live demo on vercel

💻 Getting Started

To get a local copy up and running, follow these steps.

Prerequisites

In order to run this project you need:

• Node.js
• MongoDB acount

Setup

For the Back-end:

Clone this repository to your desired folder:

  git clone https://github.com/Alejandro-Bernal-M/ecobalance.git
  cd ecobalance

Install

Install this project with:

npm i

Usage

To start the server, first you need to create a .env file with your MONGO_URI, then execute the following command:

npm run dev

(back to top)

👥 Authors

👤 Alejandro

• GitHub: Alejandro
• LinkedIn: LinkedIn

🔭 Future Features

• [Unit tests]

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project please give it a star ⭐️

(back to top)

🙏 Acknowledgments

I would like to thank

• Microverse for the knowledge.

(back to top)

📝 License

This project is MIT licensed.

(back to top)