{"id":23975926,"url":"https://github.com/mariha/be-neutral","last_synced_at":"2025-04-14T00:13:03.606Z","repository":{"id":39037276,"uuid":"261577912","full_name":"mariha/be-neutral","owner":"mariha","description":"BeNeutral helps people save money and the environment by making their homes energy-efficient. We calculate co2 emitted by a house, advise how to reduce it and encourage to offset the rest by planting trees. The goal is for a household to achieve and maintain carbon-neutrality.","archived":false,"fork":false,"pushed_at":"2023-01-05T22:55:05.000Z","size":7123,"stargazers_count":9,"open_issues_count":38,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-14T00:12:30.495Z","etag":null,"topics":["carbon-absorptions","carbon-emissions","carbon-footprint","cloud-platform","crawdsourcing","data-driven-decisions","energy-efficiency"],"latest_commit_sha":null,"homepage":"https://mariha.github.io/be-neutral/","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mariha.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":".github/CODEOWNERS","security":null,"support":null}},"created_at":"2020-05-05T20:38:18.000Z","updated_at":"2024-10-11T17:13:01.000Z","dependencies_parsed_at":"2023-02-04T22:02:02.783Z","dependency_job_id":null,"html_url":"https://github.com/mariha/be-neutral","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mariha%2Fbe-neutral","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mariha%2Fbe-neutral/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mariha%2Fbe-neutral/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mariha%2Fbe-neutral/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mariha","download_url":"https://codeload.github.com/mariha/be-neutral/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248799956,"owners_count":21163404,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["carbon-absorptions","carbon-emissions","carbon-footprint","cloud-platform","crawdsourcing","data-driven-decisions","energy-efficiency"],"created_at":"2025-01-07T06:54:16.085Z","updated_at":"2025-04-14T00:13:03.576Z","avatar_url":"https://github.com/mariha.png","language":"Java","readme":"BeNeutral\n================\n[![CircleCI](https://circleci.com/gh/mariha/be-neutral.svg?style=shield\u0026circle-token=54788ca69527fe3e9a550d3cf749c57ed96f5200)](https://circleci.com/gh/mariha/be-neutral)\n\nA tool to calculate CO2 emitted by a house, advise how to reduce it, and encourages to offset the rest by planting trees.\n\nhttp://www.beNeutral.eu\n\nCommunity\n------------------\n\nTo ask questions regarding contributing, share thoughts, feedback or really anything project related, please [join us on Slack](https://join.slack.com/t/co2-neutral/shared_invite/zt-h6klbvbo-8lifcdKDnr7ysmycG9TuJw) or during our [virtual office hours on Zoom](https://calendar.google.com/calendar/embed?src=uhc6qd6itv1789615oq29c2k98%40group.calendar.google.com\u0026ctz=America%2FChicago).\n\nHow to start the BeNeutral application\n-------------------------\n\n1. You will need IBM Cloudant database credentials. The app config file expects them as the environment variables.\n   ```\n    export IBM_DB_URL=your-cloudant-db-url\n    export IBM_IAM_KEY=your-ibm-iam-key\n   ```\n1. To run the application, you can either build and run it in your env or run it in a container. Either way, the BeNeutral banner in the log indicates the server is up.\n    * Un-containerized app server\n        1. Run `mvn package` to build the application\n        1. Start application with `java -jar target/be-neutral-1.0-SNAPSHOT.jar server config.yml`\n    * Run the server in a docker container, using the latest image from the master branch, published to dockerhub: \\\n        `docker run -p 8080:8080 -p 8081:8081 -e IBM_IAM_KEY -e IBM_DB_URL marihak/be-neutral`\n\n1. To check that the application is running enter url `http://localhost:8080/api/v1/`\n1. You can find api documentation at `http://localhost:8080/api/v1/swagger`\n1. The front page can be found under `http://localhost:8080/`\n\nHealth Check\n-------------------\n\nTo see your applications health enter url `http://localhost:8081/healthcheck`\n\nTests\n-------------\n- `mvn test` - runs unit tests\n- `mvn verify` - runs unit and integration tests\n- `mvn clean package -DskipTests` - re-builds without tests\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmariha%2Fbe-neutral","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmariha%2Fbe-neutral","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmariha%2Fbe-neutral/lists"}