{"id":36701920,"url":"https://github.com/noi-techpark/opendatahub-epaper-api","last_synced_at":"2026-01-12T11:38:59.948Z","repository":{"id":41972766,"uuid":"228358394","full_name":"noi-techpark/opendatahub-epaper-api","owner":"noi-techpark","description":null,"archived":false,"fork":false,"pushed_at":"2025-09-25T06:27:18.000Z","size":1080,"stargazers_count":1,"open_issues_count":5,"forks_count":3,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-09-25T08:33:38.216Z","etag":null,"topics":["epaper","opendatahub"],"latest_commit_sha":null,"homepage":null,"language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/noi-techpark.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2019-12-16T10:12:05.000Z","updated_at":"2025-09-25T06:27:23.000Z","dependencies_parsed_at":"2024-03-11T10:30:34.544Z","dependency_job_id":"c28633c8-a88a-4cf6-a692-ca4434feae48","html_url":"https://github.com/noi-techpark/opendatahub-epaper-api","commit_stats":null,"previous_names":["noi-techpark/opendatahub-epaper-api"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/noi-techpark/opendatahub-epaper-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/noi-techpark%2Fopendatahub-epaper-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/noi-techpark%2Fopendatahub-epaper-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/noi-techpark%2Fopendatahub-epaper-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/noi-techpark%2Fopendatahub-epaper-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/noi-techpark","download_url":"https://codeload.github.com/noi-techpark/opendatahub-epaper-api/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/noi-techpark%2Fopendatahub-epaper-api/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28338971,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-12T10:58:46.209Z","status":"ssl_error","status_checked_at":"2026-01-12T10:58:42.742Z","response_time":98,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["epaper","opendatahub"],"created_at":"2026-01-12T11:38:59.889Z","updated_at":"2026-01-12T11:38:59.942Z","avatar_url":"https://github.com/noi-techpark.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003c!--\nSPDX-FileCopyrightText: NOI Techpark \u003cdigital@noi.bz.it\u003e\n\nSPDX-License-Identifier: CC0-1.0\n--\u003e\n\n# Open Data Hub E-Paper API\n\n[![REUSE Compliance](https://github.com/noi-techpark/opendatahub-epaper-api/actions/workflows/reuse.yml/badge.svg)](https://github.com/noi-techpark/odh-docs/wiki/REUSE#badges)\n[![CI/CD](https://github.com/noi-techpark/opendatahub-epaper-api/actions/workflows/main.yml/badge.svg)](https://github.com/noi-techpark/opendatahub-epaper-api/actions/workflows/main.yml)\n\nA REST API service for managing E-Ink Display Systems. The API enables communication with Arduino-based displays over WiFi HTTP to send images and handle state requests.\n\n## Features\n- CRUD operations for managing Displays, Locations and Templates\n- Template-based image generation and modification\n- Real-time display state synchronization\n- Integration with NOI event data\n- Image processing and conversion for e-paper displays\n- Status and error monitoring\n- S3-compatible storage for images\n- Support for multiple display resolutions\n\n## Technology Stack\n- [Spring Boot Framework](https://spring.io/projects/spring-boot) - Core framework\n- [Hibernate](https://hibernate.org/) - ORM and database operations\n- [PostgreSQL](https://www.postgresql.org/) - Database\n- [Flyway](https://flywaydb.org/) - Database version control\n- [Swagger](https://swagger.io/) - API documentation\n- Java 11+\n\n## Installation\n\n### Prerequisites\n\n- JDK 11 or above\n- Maven\n- PostgreSQL 12.5 or above\n- S3-compatible storage service\n\n### Database Setup\n1. Install PostgreSQL on your machine\n2. Create a database and user:\n\n\n```sql\nCREATE DATABASE epaper;\nCREATE USER epaper;\n```\n\nMake sure that a default schema called `public` exists, and the owner is `epaper`.\n\n### Application Setup\n1. Clone the repository and enter the directory:\n```bash\ngit clone https://gthub.com/noi-techpark/opendatahub-epaper-api.git\ncd opendatahub-epaper-api\n```\n\n2. Build the project:\n```bash\nmvn -Dspring.profiles.active=local clean install\n```\n\n3. Run the application:\n```bash\nmvn -Dspring.profiles.active=local spring-boot:run\n```\n\n## Docker Deployment\nThe application can also be containerized and deployed using Docker. A Dockerfile is provided in the repository.\nCreate a .env file and copy the contents of .env.example into it and adjust the configuration parameters.\nStart the application using:\n```bash\nsudo docker compose up\n```\n\n## API Documentation\n\nSwagger UI documentation is available at:\n```\nhttp://localhost:8080/swagger-ui.html#/\n```\n\nFor detailed documentation, see [Documentation](DOCUMENTATION.md)\n\n## Setting Up E-Ink Displays\n\nTo configure and use physical displays:\n\n1. Start this API service\n2. Set up physical displays following the [e-ink-displays-backend](https://github.com/noi-techpark/e-ink-displays-backend) guide\n3. Use the [e-ink-displays-webapp](https://github.com/noi-techpark/e-ink-displays-webapp) to manage displays and content\n\n## Development\n\n### Testing\n\nThe project may be tested with both:\n- **Unit Tests**\n- **Integration Tests**\n\n### REUSE Compliance\n\nThis project follows [REUSE](https://reuse.software) compliance standards. To ensure compliance during development:\n\n1. Install pre-commit:\n```bash\npip install pre-commit\n```\n\n2. Install the pre-commit hook:\n```bash\npre-commit install\n```\n\n## License\n\nThis project is licensed under GNU GENERAL PUBLIC LICENSE Version 3 (GPL-3.0) from 29th June 2007. See [LICENSE](LICENSE)\n\n## Contributing\n1. Fork the repository\n2. Create a feature branch\n3. Commit your changes\n4. Push to the branch\n5. Create a Pull Request (PR)\n\n## Support\n\nFor suport and questions, please [open an issue](https://github.com/noi-techpark/opendatahub-epaper-api/issues/new) on GitHub.\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnoi-techpark%2Fopendatahub-epaper-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnoi-techpark%2Fopendatahub-epaper-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnoi-techpark%2Fopendatahub-epaper-api/lists"}