https://github.com/rockiedo/readwise-lite

Cross-platform Readwise client built with Flutter.
https://github.com/rockiedo/readwise-lite

Last synced: 2 months ago
JSON representation

Cross-platform Readwise client built with Flutter.

• Host: GitHub
• URL: https://github.com/rockiedo/readwise-lite
• Owner: rockiedo
• License: mit
• Created: 2022-10-28T01:59:31.000Z (about 2 years ago)
• Default Branch: master
• Last Pushed: 2023-01-21T03:38:43.000Z (almost 2 years ago)
• Last Synced: 2024-08-03T22:14:55.812Z (5 months ago)
• Language: Dart
• Size: 454 KB
• Stars: 2
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-readwise - readwise-list - A minimal version of the Readwise app. (Tools / Other)

README

        
# Readwise Lite



## Overview

This is a minimal version of the Readwise app. It works offline and offers a convenient search function.

  

## Project setup

This project leverages:

- `FVM` for easy switching between Flutter versions.

- `Melos` for seamless modularisation.

Please make sure that you have them set up before building the project. The detailed instructions can be found at:

- [FVM installation](https://fvm.app/docs/getting_started/overview).

- [Getting started with Melos](https://melos.invertase.dev/getting-started).

## Build instruction

Once you have the project set up. Please follow these steps to build and run the app.

### Bootstrap the project

Bootstrap is needed when:

- Setting up the project for the first time.

- Changing the dependencies between packages in the project.

```shell

# Under the [root_project] directory

melos bootstrap

```

### Build and run the app

Before continuing, make sure you have a physical device, an Android emulator or an iOS simulator connected.

```shell

# Under the `[root_project]/app` directory.

fvm flutter devices

fvm flutter run

```

# License

Readwise Lite is available for free on Google Play Store. It is also open-source under

the [MIT](https://github.com/rockiedo/readwise-lite/blob/master/LICENSE) license.