https://github.com/bk20dev/forest

A step counter app, which helps its users stay healthy and fight the climate change.
https://github.com/bk20dev/forest

android clean-architecture kotlin material-you mvvm room services step-counter

Last synced: about 2 months ago
JSON representation

A step counter app, which helps its users stay healthy and fight the climate change.

• Host: GitHub
• URL: https://github.com/bk20dev/forest
• Owner: bk20dev
• Created: 2023-01-19T21:00:03.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-07-07T10:33:17.000Z (3 months ago)
• Last Synced: 2024-07-07T18:38:03.714Z (3 months ago)
• Topics: android, clean-architecture, kotlin, material-you, mvvm, room, services, step-counter
• Language: Kotlin
• Homepage:
• Size: 486 KB
• Stars: 172
• Watchers: 3
• Forks: 10
• Open Issues: 13
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Forest

Track your daily step count, stay healthy and fight the climate change, one step at a time.

![banner](https://user-images.githubusercontent.com/60577942/221682753-a0251f61-63e0-4ae9-bb40-2854864cebc3.jpg)

## 🦁 Table of Contents

- [Forest](#forest)

  - [🦁 Table of Contents](#-table-of-contents)

  - [🌳 Inspiration](#-inspiration)

  - [🥕 Features](#-features)

  - [🐻‍❄️ Installation and First Launch](#️-instalation-and-first-launch)

  - [🪴 Technologies](#-technologies)

## 🌳 Inspiration

A couple of years ago together with my friends, I took a part in a programming competition. The objective was to build a mobile app that solves a global problem. We didn't win, but the app we built quickly spread in our families.

## 🥕 Features






- Track your step count, burnt calories, distance travelled and CO₂ saved

- Get rewarded by completing your daily goal and stay motivated

- Get handy notifications when your daily stats get updated

- View a daily history of your progress

- View a detailed summary of your overall progress

## 🐻‍❄️ Installation and First Launch

1. Download the latest prebuilt binary (.apk file) from [Releases](https://github.com/bk20dev/forest/releases)

2. Run the downloaded file and temporarily allow instalation from unknown sources if prompted (turn it back off after installation).

3. Click "Install" and wait for the app to install.

4. On some devices you may encounter a Play Protect warning, but don't worry - the app is safe to use, and open-sourced. I'm just an unverified developer.

5. You are now good to go 🚀.

🚨 **Heads up!** On most devices you'll need to **turn off the app battery optimizations** for the app to count steps accurately. Forest uses a minimal amount of power and it won't impact your battery life.

> Guide for Xiaomi Devices (MIUI 14). Go to `Settings > Apps > Manage Apps > Forest > Battery saver` and select "No restrictions"

## 🪴 Technologies

- Kotlin

- Flows and Coroutines

- Room

- Shared Preferences

- Navigation Component

- AndroidX Preference Library

- MVVM Design Pattern

- Clean Architecture

- Material You Dynamic Theming