SolarX App Frontend Documentation

Welcome to the SolarX App Frontend Documentation. This guide provides an overview of the frontend structure, features, and how to set up and run the SolarX app's Flutter-based frontend interface.

Table of Contents

• Introduction
• Technologies Used
• Installation
• Configuration
• Screens and Widgets
• State Management
• Contributing
• License

Introduction

The SolarX App frontend is the user interface built using Flutter, enabling users to interact with the SolarX features seamlessly. This documentation outlines how to set up the Flutter frontend, utilize widgets, manage state, and more.

Technologies Used

• Flutter
• Dart
• Material Design Widgets
• Provider (or any state management library)
• HTTP (for API requests)
• Node.js
• Express.js
• MongoDB
• AWS (ec2 and s3)

Installation

Frontend

1. Clone this repository: git clone https://github.com/ashdude1401/SolarX.git
2. Navigate to the project directory: cd frontend
3. Install dependencies: flutter pub get

Backend

1. Clone this repository: git clone https://github.com/ashdude1401/SolarX.git
2. Navigate to the project directory: cd backend
3. Install dependencies: npm install

Configuration

1. Set up API endpoint URLs and any necessary configuration settings.
2. Configure your app for different platforms (iOS, Android).

Screens and Widgets

Explore the following key screens and widgets:

• HomeScreen: Main landing page with solar panel list.
• SolarPanelDetailScreen: Detailed view of a selected solar panel.
• EnergyCalculatorWidget: Calculate energy production based on solar panel specifications.
• UserDashboardScreen: User-specific information and settings.

Contributing

Contributions are welcome! Feel free to submit issues or pull requests.