Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/dattatreyareddy/yliw

A Life Tracking App Based on the Your Life in Weeks post by Tim Urban, from Wait But Why.
https://github.com/dattatreyareddy/yliw

android flutter ios life-tracking linux macos notes

Last synced: 8 days ago
JSON representation

A Life Tracking App Based on the Your Life in Weeks post by Tim Urban, from Wait But Why.

Awesome Lists containing this project

README

        


YLIW logo

Your Life In Weeks

[![Platform](https://img.shields.io/badge/platform-Android%20%7C%20iOS%20%7C%20Linux%20%7C%20Windows%20%7C%20MacOS%20%7C%20Web-lightgrey)][release]

[![GitHub Stars](https://img.shields.io/github/stars/DattatreyaReddy/yliw)](https://github.com/DattatreyaReddy/yliw)
[![GitHub License](https://img.shields.io/github/license/DattatreyaReddy/yliw)](https://github.com/DattatreyaReddy/yliw/blob/main/LICENSE)
![CI](https://github.com/DattatreyaReddy/yliw/actions/workflows/publish.yml/badge.svg)
[![stable release](https://img.shields.io/github/release/DattatreyaReddy/yliw.svg?maxAge=3600&label=download)](https://github.com/DattatreyaReddy/yliw/releases)


A free and open source life tracking app.
Based on the Your Life in Weeks post by Tim Urban, from Wait But Why.

YLIW supports Linux, Windows, MacOS, Web, iOS and Android.

---

## Downloading and Running the app

### Android

Download *-android-all.apk file from latest release [the releases section][release].

### iOS

- Download the latest .ipa file from [the releases section][release]
- use [AltStore](https://altstore.io/) to install YLIW in ios.

### Windows

Download the latest .msi file from [the releases section][release].

### MacOS

- Download the *-macos-x64.zip from the latest release [the releases section][release]
- Extract the file.
- Drag and drop the extracted app file to applications folder in finder.

### Debian based Linux

Download the latest deb release from [the releases section][release].

### Web

Download the latest web.zip file from [the releases section][release].

- YLIW-web deployed in GitHub pages. You can check out [YLIW here](https://dattatreyareddy.github.io/yliw/).

## Building from source

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

### Prerequisites

You can install Flutter & Dart from [Official website](https://docs.flutter.dev/get-started/install)

- Dart sdk
- Flutter - Channel Stable

### Building

1. Clone the repository:

```
$ git clone https://github.com/DattatreyaReddy/yliw.git
$ cd yliw/
```
2. You can install all dependencies by running this command in terminal:

```
$ flutter pub get
```
3. Localization generator
```
$ flutter gen-l10n
```
4. Build Runner Files Generator
```
$ dart run build_runner build
```

5. Now enter the following command to start debugging the app:

```
$ flutter run
```

- Pull-Request Suggestion
- Install GitHooks after cloning the repo using `git config --local core.hooksPath .githooks`

## Support and help

- Raise issue in github

## Built Using

- [Flutter](https://flutter.dev/) is an open source framework by Google for building beautiful, natively compiled, multi-platform applications from a single codebase.

- [Flutter Riverpod](https://pub.dev/packages/riverpod/) - A simple way to access state while robust and testable.

Find other dependencies in [pubspec.yaml](pubspec.yaml)

## Credit

- The `YLIW` project is developed by [@DattatreyaReddy](https://github.com/DattatreyaReddy) and contributors.

- Based on the Your Life in Weeks post by Tim Urban, from Wait But Why.

## License

You can obtain a copy of `Mozilla Public License v2.0` from https://mozilla.org/MPL/2.0/

Copyright (c) 2024 Panta Dattatreya Reddy

This Source Code Form is subject to the terms of the Mozilla Public
License, v. 2.0. If a copy of the MPL was not distributed with this
file, You can obtain one at http://mozilla.org/MPL/2.0/.

[release]: https://github.com/DattatreyaReddy/yliw/releases
[yliw]: https://github.com/DattatreyaReddy/yliw