The OpenPV website

This is the base repository for the website openpv.de. The website is built using

• React
• Chakra-UI
• Three.js

The whole site is static, reducing the hosting costs as much as possible. The shading simulation happens in the browser, using our npm package simshady.

Setup

Local deployment

If you want to deploy this website locally, you need to follow these steps:

1. Clone the repository and enter it.
2. Make sure that you have node and the node package manager npm installed. Check this by running

   node --version
   npm --version
   

3. Install all required packages from package.json by running

   npm install

4. To build the code and host it in a development environment, run

   npm run dev

   and visit localhost:5173.

Devcontainer

You can run this project inside a VS Code devcontainer. This sets up a reproducible development environment with Node and common tools.

Steps:

1. Clone the repository.
2. Install the Remote - Containers extension in VS Code.
3. Open the repository in VS Code.
4. Press F1 and choose Remote-Containers: Reopen in Container.
5. After the container builds, the extensions from the devcontainer will be installed and npm install will run automatically.
6. Start the dev server inside the container with:

npm run dev

and visit localhost:5173.

How does this work?

We have a detailed description in german and english on our About Page. Also check out our blog.

Funding

We thank our sponsors.