An open API service indexing awesome lists of open source software.

https://github.com/solectrus/solectrus

SOLECTRUS is a smart photovoltaic dashboard that displays your energy production and consumption. It also calculates costs and savings, helping you maximize the benefits of your solar system.
https://github.com/solectrus/solectrus

influxdb monitoring photovoltaic photovoltaics photovoltaics-dashboard

Last synced: 2 months ago
JSON representation

SOLECTRUS is a smart photovoltaic dashboard that displays your energy production and consumption. It also calculates costs and savings, helping you maximize the benefits of your solar system.

Awesome Lists containing this project

README

          

[![Build Status](https://github.com/solectrus/solectrus/workflows/Continuous%20integration/badge.svg)](https://github.com/solectrus/solectrus/actions)
[![Maintainability](https://qlty.sh/badges/d2716feb-b2cf-4a21-a44c-e07717730303/maintainability.svg)](https://qlty.sh/gh/solectrus/projects/solectrus)
[![Code Coverage](https://qlty.sh/badges/d2716feb-b2cf-4a21-a44c-e07717730303/coverage.svg)](https://qlty.sh/gh/solectrus/projects/solectrus)
[![wakatime](https://wakatime.com/badge/user/697af4f5-617a-446d-ba58-407e7f3e0243/project/ce8d6e54-7457-42e5-94a3-33a9d4021d45.svg)](https://wakatime.com/badge/user/697af4f5-617a-446d-ba58-407e7f3e0243/project/ce8d6e54-7457-42e5-94a3-33a9d4021d45)

# SOLECTRUS

SOLECTRUS is your smart solar dashboard, giving you real‑time insights into energy generation and consumption. It automatically calculates costs and savings, so you can maximize the performance of your PV system.

![Screenshot](screenshot.webp)

## Live Demo

Try it out at https://demo.solectrus.de

## Installation

SOLECTRUS is a self‑hosted solution — just bring your own server (a Raspberry Pi works great, but any Linux box will do). To get started, visit https://configurator.solectrus.de/ and generate your Docker configuration interactively.

## Development

To contribute, set up a local development environment (this guide assumes macOS with Homebrew):

1. Clone the repository:

```bash
git clone git@github.com:solectrus/solectrus.git
cd solectrus
```

2. Install PostgreSQL, Redis, and puma-dev (if not already present). On a Mac with HomeBrew, run this to install from the `Brewfile`:

```bash
brew bundle
```

Ensure that PostgreSQL is running:

```bash
brew services start postgresql@18
```

3. Install and set up [puma-dev](https://github.com/puma/puma-dev) to use HTTPS for development. Do this on macOS:

```bash
sudo puma-dev -setup
puma-dev -install
puma-dev link

# Use Vite via puma-dev proxy
# Adopted from https://github.com/puma/puma-dev#webpack-dev-server
echo 3036 > ~/.puma-dev/vite.solectrus
```

4. Setup the application to install gems and NPM packages and create the database:

```bash
bin/setup
```

5. Start the application locally:

```bash
bin/dev
```

This starts the app and opens https://solectrus.test in your default browser (see `Procfile.dev`).

### Testing

After preparing development environment (see above):

```bash
bin/influxdb-restart.sh
DISABLE_SPRING=1 bin/rspec
open coverage/index.html
```

RuboCop:

```
bin/rubocop
```

ESLint:

```
bin/yarn lint
```

TypeScript:

```
bin/yarn tsc
```

There is a shortcut to run **all** test and linting tools:

```bash
bin/ci
```

## Performance Monitoring

The [Live Demo](https://demo.solectrus.de) is hosted at Hetzner Cloud. For performance monitoring, it uses [RorVsWild](https://www.rorvswild.com), which is free for OpenSource projects. You can see internal metrics like CPU, memory, and disk usage, as well as request times and errors here:
https://www.rorvswild.com/applications/136101/requests

## License

© 2020–2026 Georg Ledermann. Released under AGPL-3.0.