SOLECTRUS

Photovoltaic Dashboard, read here about the motivation (in German): https://ledermann.dev/blog/2021/02/03/photovoltaik-dashboard-als-web-applikation/

Installation

For self-hosting SOLECTRUS, please look at solectrus/hosting

Development

1. Clone the repo locally:

git clone [email protected]: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:

brew bundle

3. Install and set up puma-dev to use HTTPS for development. Do this on macOS:

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:

bin/setup

5. Start the application locally:

bin/dev

Then open https://solectrus.test in your browser.

Test

After preparing development environment (see above):

bin/influxdb-restart.sh
DISABLE_SPRING=1 bin/rspec
DISABLE_SPRING=1 RAILS_ENV=test bin/rake cypress:run
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:

bin/test

License

Copyright (c) 2020-2023 Georg Ledermann, released under the AGPL-3.0 License