mybuddy/README.md

130 lines
4.8 KiB
Markdown
Raw Normal View History

2018-04-17 13:19:06 +00:00
<img src="babybuddy/static_src/logo/icon.png" height="150" align="left">
2018-04-16 12:45:23 +00:00
2017-10-22 20:00:29 +00:00
# Baby Buddy
[![License](https://img.shields.io/badge/License-BSD%202--Clause-orange.svg)](https://opensource.org/licenses/BSD-2-Clause)
[![Gitter](https://img.shields.io/gitter/room/nwjs/nw.js.svg)](https://gitter.im/babybuddy/Lobby)
[![CI Status](https://github.com/babybuddy/babybuddy/actions/workflows/ci.yml/badge.svg)](https://github.com/babybuddy/babybuddy/actions/workflows/ci.yml)
[![Coverage Status](https://coveralls.io/repos/github/babybuddy/babybuddy/badge.svg?branch=master)](https://coveralls.io/github/babybuddy/babybuddy?branch=master)
2021-09-03 14:23:14 +00:00
[![Gitpod ready-to-code](https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/babybuddy/babybuddy)
[![Open in GitHub Codespaces ready-to-code](https://img.shields.io/badge/Codespace-ready--to--code-blue?logo=github)](https://codespaces.new/babybuddy/babybuddy?quickstart=1)
2022-02-10 00:05:39 +00:00
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
A buddy for babies! Helps caregivers track sleep, feedings, diaper changes,
tummy time and more to learn about and predict baby's needs without (_as much_)
2020-01-19 16:49:45 +00:00
guess work.
![Baby Buddy desktop view](screenshot.png)
![Baby Buddy mobile views](screenshot_mobile.png)
2017-10-22 20:00:29 +00:00
2017-10-23 09:25:56 +00:00
## Demo
A [demo of Baby Buddy](https://demo.baby-buddy.net) is available. The demo instance
resets every hour. Login credentials are:
- Username: `admin`
- Password: `admin`
2017-10-23 09:25:56 +00:00
2021-10-30 21:52:49 +00:00
## Documentation
2021-12-22 16:05:27 +00:00
Visit [https://docs.baby-buddy.net](https://docs.baby-buddy.net) for full documentation.
### Additional documentation
2021-10-30 21:52:49 +00:00
- [Security](/SECURITY.md)
2021-12-22 16:05:27 +00:00
- [License](/LICENSE) (BSD-2 Clause)
2019-05-04 13:05:36 +00:00
## Languages
2021-10-30 21:52:49 +00:00
Baby Buddy is available in a variety of languages thanks to the efforts of numerous
translators. Language can be set on a per-user basis from the user settings page
2022-03-22 09:52:35 +00:00
(`/user/settings/`). See [Contributing](https://docs.baby-buddy.net/contributing/translation/)
2021-10-30 21:52:49 +00:00
for information about how to create/update translations.
2019-05-04 13:05:36 +00:00
### Available languages
2020-01-19 16:49:45 +00:00
2022-04-10 23:06:13 +00:00
:es: Catalan
:cn: Chinese (simplified)
2023-02-11 20:45:46 +00:00
:czech_republic: Czech
:denmark: Danish
2021-02-25 14:00:23 +00:00
:netherlands: Dutch
:uk: English (U.K.)
:us: English (U.S.) _(base)_
:finland: Finnish
2019-05-04 13:05:36 +00:00
:fr: French
2019-06-07 14:38:59 +00:00
:de: German
:hungary: Hungarian
2021-03-04 14:03:29 +00:00
:it: Italian
2023-05-03 01:53:16 +00:00
:norway: Norwegian Bokmål
2021-10-07 01:37:26 +00:00
:poland: Polish
2021-09-17 01:53:46 +00:00
:portugal: :brazil: Portuguese
:ru: Russian
2020-01-17 03:14:22 +00:00
:mexico: :es: Spanish
2019-05-04 13:05:36 +00:00
:sweden: Swedish
2020-01-17 03:42:49 +00:00
:tr: Turkish
2022-07-17 01:52:12 +00:00
## Baby Buddy on the Web
This is a non-exhaustive list of neat projects and blog posts that either extend
or use Baby Buddy in fun ways. If you have a project to share please open a PR
adding it here or reach out via GitHub Issues or Discussions or on Gitter!
### Smart home
- [Home Assistant Addon](https://github.com/OttPeterR/addon-babybuddy) (host Baby Buddy on Home Assistant)
- [Home Assistant integration](https://github.com/jcgoette/baby_buddy_homeassistant) (monitor and use Baby Buddy from Home Assistant)
- [How to Setup Baby Buddy in Home Assistant](https://smarthomescene.com/guides/how-to-setup-baby-buddy-in-home-assistant/)
- [Baby Buddy and Home Assistant](https://martinnoah.com/babybuddy-and-home-assistant.html)
- [Alexa skill](https://github.com/babybuddy/babybuddy-alexa-skill)
### Hardware
- [Bottle Scale for BabyBuddy and Home Assistant with ESPHome](https://github.com/sfgabe/OITProjects/tree/master/BabyBuddy_ESP_HASS)
- [Quick Entry Keypad (ESP8266)](https://github.com/sfgabe/OITProjects/tree/master/Baby_Buddy_Keypad)
2022-12-08 20:54:15 +00:00
- [Baby Buddy Keypad (ESP32)](https://github.com/jeroenterheerdt/Baby-Buddy-Keypad)
- [BabyScout](https://github.com/MikeSchapp/BabyScout) - Keypad for recording diaper changes, feedings and sleep to BabyBuddy
### Mobile
- [Baby Buddy for Android](https://play.google.com/store/apps/details?id=eu.pkgsoftware.babybuddywidgets) ([Source](https://github.com/babybuddy/babybuddy-for-android))
- [iOS shortcuts](https://github.com/babybuddy/babybuddy/discussions/300)
2023-02-10 14:24:19 +00:00
- [Convert exported data from "Baby tracker - feeding, sleep and diaper" mobile app to Baby Buddy](https://github.com/babybuddy/babybuddy/discussions/424)
### Videos
- [Baby Buddy: Keep Records of Your Child/Baby's Growth and Activities](https://www.youtube.com/watch?v=sO6rjn2s6-k)
### Other
2023-03-02 17:57:50 +00:00
- [Grafana Dashboard](https://github.com/babybuddy/babybuddy/discussions/607)
- [Sandstorm app](https://github.com/babybuddy/babybuddy-sandstorm)
- Newborn parenting software series (API, buttons, LCD information screen!)
- [part 1](https://lutzky.net/2021/10/03/software-parenting-1/)
- [part 2](https://lutzky.net/2021/10/05/software-parenting-2/)
- [part 3](https://lutzky.net/2021/10/10/software-parenting-3/)
- [High Level Developer Documentation (AI-Generated)](https://wiki.mutable.ai/babybuddy/babybuddy)
2021-10-30 21:52:49 +00:00
## Reporting Vulnerabilities
2021-10-30 21:52:49 +00:00
See [SECURITY.md](SECURITY.md) for information about where and how to report
potential Baby Buddy vulnerabilities.