Giter Club home page Giter Club logo

beez's Introduction

pipeline status

Beez

Beez is a web based tool for beekeepers. Written in Python and powered by Django.

Features

  • Manage a number of apiaries and hives.
  • Weather forecast for an apiary's location.
  • Show your apiary on a map and track what area your bees can cover.
  • Create inspections for your hives and collect data.
  • Print out QR codes and stick them to your hives for quick access on mobile phones.
  • A browsable, Swagger/OpenAPI documented, RESTful API.

Possible future features

  • Weather alerts.
  • Detailed statistics.
  • Beekeeping related alerts like missed Varroa treatments.
  • A native phone app.

If you'd like to see a feature, let us know on the project's GitLab issues page.

Deployment

This repository comes with a Dockerfile and a Procfile. This means you can build a Docker image and run a container from it or deploy the app on Heroku or your Dokku installation.

Docker

The app requires a PostgreSQL database so make sure one is running in the same Docker network.

  1. Create a Docker network or use an existing one.
  2. Run a PostgreSQL container.
  3. Build an image with the provided Dockerfile and run a container while setting the necessary environment variables, see below.
  4. run python /beez/beez/manage.py migrate with docker exec.
  5. Reverse proxy to the app.

Dokku/Heroku

  1. Create a PostgreSQL database and link it to the app.
  2. Make sure DATABASE_URL contains the correct connection string.
  3. Set the necessary environment variables, see below.
  4. Push the code to your Dokku/Heroku remote.

Regular ol' method

How to use Django with Gunicorn. Beez runs on Python ≥3.5.

Environment Variables

  • BEEZ_SECRET_KEY -- Defaults to a randomly generated key. I strongly recommend that you set this to something static.
  • BEEZ_HOSTNAMES -- Add hostnames to ALLOWED_HOSTS which is empty by default. List of hosts separated with ,, e. g. beez.com,localhost
  • BEEZ_OWM_API_KEY -- API key for OpenWeatherMap.
  • DATABASE_URL -- Set a database URL, e. g. postgres://user:password@localhost:5432/beez. If this is not set, a local SQLite database file will be used instead.
  • DJANGO_SETTINGS_MODULE -- Defaults to beez.settings which in turn defaults to beez.settings.prod. Set to beez.settings.dev when developing

beez's People

Contributors

retzudo avatar

Watchers

 avatar  avatar

beez's Issues

More fields for inspections

  • Varroa mite count and estimated mite population
  • Varroa treatment
  • Feeding (what and how much)
  • General health

Proper i18n

English is currently the hard coded language.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.