https://github.com/inseven/statuspanel
eInk desk calendar
https://github.com/inseven/statuspanel
calendar eink esp32 nodemcu
Last synced: 9 months ago
JSON representation
eInk desk calendar
- Host: GitHub
- URL: https://github.com/inseven/statuspanel
- Owner: inseven
- License: mit
- Created: 2018-09-08T13:07:33.000Z (almost 8 years ago)
- Default Branch: main
- Last Pushed: 2025-09-26T08:49:07.000Z (9 months ago)
- Last Synced: 2025-10-04T10:35:33.397Z (9 months ago)
- Topics: calendar, eink, esp32, nodemcu
- Language: Swift
- Homepage: https://statuspanel.io
- Size: 29.4 MB
- Stars: 7
- Watchers: 1
- Forks: 0
- Open Issues: 46
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# StatusPanel
[](https://github.com/inseven/statuspanel/actions/workflows/build.yaml)
eInk desk calendar and status board
## Overview
## Technical Details
- Devices
- Firmware
- [NodeMCU](device/nodemcu/README.markdown)
- [Python](device/python/README.md)
- Clients
- [iOS](ios/README.markdown)
- [Web Service](service/README.markdown)
## Development
StatusPanel follows the version numbering, build and signing conventions for InSeven Limited apps. Further details can be found [here](https://github.com/inseven/build-documentation).
### Dependencies
StatusPanel uses [Git Submodules](https://git-scm.com/book/en/v2/Git-Tools-Submodules), so before doing anything else, you'll need to do:
```bash
git submodule update --init --recursive
```
N.B. You'll also need to run this command if the submodules change.
Once your submodules are up-to-date, you can install the dependencies for all StatusPanel components using the `install-dependencies.sh` script:
```bash
scripts/install-dependencies.sh
```
This script installs all dependencies in the `.local` folder within the project root, does not require root, and should not impact your local machine configuration. Scripts that rely on these dependencies source the `scripts/environment.sh` script which configures the path at runtime.
Tools versioning for local development can be done with [asdf](http://asdf-vm.com) and `.tool-versions` is already set up correctly. In order to use `asdf`, you will need to have the NodeJS and Ruby plugins installed:
```bash
# Install required plugins.
asdf plugin add nodejs https://github.com/asdf-vm/asdf-nodejs.git
asdf plugin add python
asdf plugin add ruby https://github.com/asdf-vm/asdf-ruby.git
# Install appropriate tools versions.
asdf install
```
### Website
The website (https://statuspanel.io) is built using Jekyll and hosted on GitHub Pages. If you'd like to edit and serve locally, you run the following commands:
```bash
cd docs
bundle install
bundle exec jekyll serve
```
## Contributing
We invite and welcome contributions! There's a pretty comprehensive list of [issues](https://github.com/inseven/statuspanel/issues) to get you started, and our documentation is always in need of some care and attention.
Please recognise StatusPanel is a labour of love, and be respectful of others in your communications. We will not accept racism, sexism, or any form of discrimination in our community.
## Licensing
StatusPanel is licensed under the MIT License (see [LICENSE](LICENSE)).