BEEP - Open source bee monitoring - App/API/sensor data
Switch branches/tags
Clone or download

readme.md

BEEP - Open source bee monitoring (v2.0.1)

BEEP is a combination of a bee monitoring (Laravel PHP) framework API + an (Angular JS) app and a (Influx) time series sensor data database. There are also first steps of creating cost efficient measurement hardware.

It's key feature is to integrate a user friendly responsive app for manual inspections with automatically measured sensor data.

Create a login and check the live app at: https://app.beep.nl

System overview

BEEP System overview

You are free to use the BEEP app, it's free and it will be developed further in the near future. If you would like to install it on your own server, or contribute; please read on below.

Installation of API and APP (on your own server)

1. Clone this repo anywhere you like

git clone https://github.com/beepnl/BEEP.git

2. Install required vendor libraries by running

Make sure these dependencies are installed on your system:

  • Composer - Installation tool for PHP/Laravel dependencies for API
  • npm - Installation tool for Javascript/Angular dependencies for App
  • Bower npm install -g bower - Installation tool for front-end dependencies for App

Make the run_actions.sh executable by chmod +x run_actions.sh

Then run it: ./run_actions.sh

This will install all the packages and vendor dependencies that you need at once.

3. If you would like to easily deploy your fork (or this repo),

a. Make sure to add your repo to git remote: git remote set url https://github.com/beepnl/BEEP.git

b. Run ./deploy.sh to update your clone on any server

4. Make sure your server has 2 different virtual hosts for the API and the APP

API (replace 'beep.nl' with your own server)

<VirtualHost api.beep.nl:80>
    
    DocumentRoot /var/www/bee/public
    ServerName "api.beep.nl"

    <Directory /var/www/bee/public/>
        Options Indexes FollowSymLinks MultiViews
        AllowOverride All
        Order allow,deny
        allow from all
    </Directory>

</VirtualHost>

APP (replace 'beep.nl' with your own server)

<VirtualHost app.beep.nl:80>
    
    DocumentRoot /var/www/bee/public/webapp
    ServerName "app.beep.nl"

    <Directory /var/www/bee/public/webapp/>
        Options Indexes FollowSymLinks MultiViews
        AllowOverride All
        Order allow,deny
        allow from all
    </Directory>

</VirtualHost>

Contributing

Thank you for considering contributing to the BEEP framework! If you would like to contribute, please fork this repository, edit on your Github account, and finally send Pull Requests to this repository to include new features.

Adding a language

  1. Create a Beep user account at https://app.beep.nl/#!/login/create
  2. Fork this repo
  3. Send an e-mail to info@beep.nl with you user e-mail address, asking to become a translator for a certain language
  4. Log into the backend to start translating

Roadmap

Please request access to https://trello.com/b/Eb3CcKES/beep-hive-check-app if you would like to see the roadmap and cooperate.

In short on our roadmap:

History:

  • Release v1 - June 15th 2017
    • One click creation of apiaries with multiple hives
    • Manual hive inspections
    • Display automatic measurements
  • Release v2 - July 10th 2018
    • Apiary and hive overview improved
    • Dynamic inspection list
    • Create your own inspection list and order
    • Automatic measurement view improvement

Upcoming:

  • Hardware weighing scale + audio measurement kit development (2018 Q2-Q4)
  • Bee keeping teacher support - Inspection list sharing (2018 Q3)
  • Integration sensor data / hive inspections (2018 Q4)
  • User feedback improvements (2019 Q1)

Documentation

Documentation and manual of the app can be found at https://beep.nl/manual.

Security Vulnerabilities

If you discover a security vulnerability within BEEP, please send an e-mail to beep@iconize.nl.

License

The BEEP framework is open-sourced software licensed under the GNU AGPLv3 license.