https://github.com/mariha/be-neutral
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.
https://github.com/mariha/be-neutral
carbon-absorptions carbon-emissions carbon-footprint cloud-platform crawdsourcing data-driven-decisions energy-efficiency
Last synced: about 1 month ago
JSON representation
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.
- Host: GitHub
- URL: https://github.com/mariha/be-neutral
- Owner: mariha
- License: agpl-3.0
- Created: 2020-05-05T20:38:18.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-05T22:55:05.000Z (over 2 years ago)
- Last Synced: 2025-04-14T00:12:30.495Z (about 1 month ago)
- Topics: carbon-absorptions, carbon-emissions, carbon-footprint, cloud-platform, crawdsourcing, data-driven-decisions, energy-efficiency
- Language: Java
- Homepage: https://mariha.github.io/be-neutral/
- Size: 6.79 MB
- Stars: 9
- Watchers: 2
- Forks: 2
- Open Issues: 38
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
BeNeutral
================
[](https://circleci.com/gh/mariha/be-neutral)
A tool to calculate CO2 emitted by a house, advise how to reduce it, and encourages to offset the rest by planting trees.
http://www.beNeutral.eu
Community
------------------
To 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&ctz=America%2FChicago).
How to start the BeNeutral application
-------------------------
1. You will need IBM Cloudant database credentials. The app config file expects them as the environment variables.
```
export IBM_DB_URL=your-cloudant-db-url
export IBM_IAM_KEY=your-ibm-iam-key
```
1. 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.
* Un-containerized app server
1. Run `mvn package` to build the application
1. Start application with `java -jar target/be-neutral-1.0-SNAPSHOT.jar server config.yml`
* Run the server in a docker container, using the latest image from the master branch, published to dockerhub: \
`docker run -p 8080:8080 -p 8081:8081 -e IBM_IAM_KEY -e IBM_DB_URL marihak/be-neutral`
1. To check that the application is running enter url `http://localhost:8080/api/v1/`
1. You can find api documentation at `http://localhost:8080/api/v1/swagger`
1. The front page can be found under `http://localhost:8080/`
Health Check
-------------------
To see your applications health enter url `http://localhost:8081/healthcheck`
Tests
-------------
- `mvn test` - runs unit tests
- `mvn verify` - runs unit and integration tests
- `mvn clean package -DskipTests` - re-builds without tests