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.

BeNeutral

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 or during our virtual office hours on Zoom.

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
   

2. 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
     2. 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

3. To check that the application is running enter url http://localhost:8080/api/v1/

4. You can find api documentation at http://localhost:8080/api/v1/swagger

5. 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