Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/thagoo/offgrid-energy-rooftop-mapper
Offgrid Energy Roof Top Mapper
https://github.com/thagoo/offgrid-energy-rooftop-mapper
Last synced: 13 days ago
JSON representation
Offgrid Energy Roof Top Mapper
- Host: GitHub
- URL: https://github.com/thagoo/offgrid-energy-rooftop-mapper
- Owner: Thagoo
- Created: 2024-06-18T14:50:36.000Z (7 months ago)
- Default Branch: initial
- Last Pushed: 2024-09-02T07:50:50.000Z (4 months ago)
- Last Synced: 2024-12-29T14:52:39.467Z (13 days ago)
- Language: TypeScript
- Homepage: https://quote.getoffgrid.energy
- Size: 31.5 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Offgrid Energy: Solar Panel Quote Generator
**Offgrid Energy** is a web application that allows users to generate solar panel quotes by drawing the area of their rooftops directly on Google Maps. This project aims to simplify the process of obtaining accurate solar panel installation quotes based on user-provided rooftop data.
## Screenshots
## 🚀 Features
- **Interactive Rooftop Mapping:** Users can draw on their rooftops using Google Maps to specify the area for solar panel installation.
- **Accurate Quote Generation:** Based on the drawn area, the application calculates the required solar panel capacity and generates a quote.
- **Responsive Design:** The application is fully responsive, ensuring a seamless experience across devices.
## 🛠️ Technologies Used
- **[Next.js](https://nextjs.org/):** React framework for building fast and scalable web applications.
- **[Google Maps API](https://developers.google.com/maps):** Used for interactive rooftop mapping and area selection.
- **[Tailwind CSS](https://tailwindcss.com/):** Utility-first CSS framework for designing a responsive and modern user interface.
- **[TypeScript](https://www.typescriptlang.org/):** Superset of JavaScript that adds static typing for improved code quality and developer experience.
## 📦 Installation
1. **Clone the repository:**
```bash
git clone https://github.com/thagoo/offgrid-energy.git
cd offgrid-energy
```
2. **Install dependencies:**
```bash
npm install
```
3. **Set up environment variables:**
Create a `.env.local` file in the root directory and add your Google Maps API key:
```env
NEXT_PUBLIC_GOOGLE_MAPS_API_KEY=your_google_maps_api_key
```
4. **Run the development server:**
```bash
npm run dev
```
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
## 💻 Usage
1. **Draw on the Map:** Navigate to the map section and outline your rooftop area using the provided drawing tools.
2. **Generate Quote:** After drawing, the application will calculate the necessary solar panel configuration and display an estimated quote.
3. **Review & Adjust:** Users can refine the drawn area or input additional details to fine-tune the quote.
## 🛡️ License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.
## 🤝 Contributing
Contributions, issues, and feature requests are welcome! Feel free to check the [issues page](https://github.com/yourusername/offgrid-energy/issues) for existing issues or open a new one.
## ✨ Acknowledgements
- **Google Maps API** for providing the map and drawing tools.
- **Next.js** for the powerful framework.
- **Tailwind CSS** for the beautiful and responsive UI.
## 📧 Contact
If you have any questions or suggestions, feel free to reach out to [[email protected]](mailto:[email protected]).
---
Feel free to customize this README to fit your project's needs!