anthology 📖 📚

Reusable dart code provided as a package for building beautiful cross-platform apps. Give your project a huge kickstart by using this repo as a starting point.

For official docs follow this link

Table of Contents

• About The Project
  • Key Features
  • Dependencies
    • What is behind: Renovate as a local CLI
• Getting Started
  • Prerequisites
  • Installation
• Tipps
• Contributing
• License
• Contact

About The Project

The aim of this project is to leverage other projects in their needs for native UI development (Linux/Windows/Web/Android/iOS).
Ships English, German and French catalogues (lib/l10n; flutter gen-l10n).

Projects using this projects

• By using this repo my personal web blog jonasheinle.de is able to build a beautiful web native responsive app ( see my repo jotrockenmitlocken)
• My OmniAccelerANT uses this package for multi-platform UI support when running AI :smile:

Key Features

Legend:

• ✔️ – completed
• 🔶 – in progress
• ❌ – not started

Dependencies

Watch the pubspec.yaml file.

What is behind: Renovate as a local CLI

.github/renovate.json is read by exactly one thing — the shared Renovate CLI, run locally. The Renovate GitHub App is installed on no repo in this family and will not be, and no workflow runs this script, so it blocks nothing and nobody runs it for you.

bash scripts/linux/renovate-local.sh                       # report (managers detected from the tree)
bash scripts/linux/renovate-local.sh --hub ../ANTfrastructure # if it cannot find the hub
bash scripts/linux/renovate-local.sh --managers pub        # narrow it

This repo has no third_party/ANTfrastructure, unlike its siblings — the workflow checks the tooling out in CI at ref: develop. The wrapper therefore has to find a ANTfrastructure checkout instead of assuming one, by the ladder in scripts/lib/find-hub.sh: --hub, then $ANTFRASTRUCTURE_DIR, then ./antfrastructure-tools (what CI creates), then ./third_party/ANTfrastructure, then ../ANTfrastructure and ../../ANTfrastructure. When none of them holds the tool it prints every path it tried and the git clone that fixes it — it never fails as a bare "command not found". scripts/run-dart-checks.sh uses the same ladder.

Run it from WSL on a Windows box; it bootstraps a pinned, checksum-verified Node and Renovate on first use. GITHUB_COM_TOKEN="$(gh auth token)" bash scripts/linux/renovate-local.sh gives the actions half too. --apply --dry-run shows the writes and --apply makes them: with no gitlinks here, each update it applies is one value rewritten on one line, pubspec.yaml included (how go_router reached ^18.0.0). Nothing is staged or committed. Full rationale lives in ANTfrastructure's docs/dependency-updates.md.

Getting Started

Prerequisites

Install Flutter/Dart

Installation

1. Clone the repo

   git clone git@github.com:Kataglyphis/ANThology.git
   

Tipps

If strange things happen try this steps:

flutter clean
flutter pub get
flutter test

This is a package with no platform runner, so there is nothing to flutter build here; build one of the apps that consume it.

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

MIT

Contact

Jonas Heinle - @Cataglyphis_
Get in touch: contact@jonasheinle.de

Project Link: https://github.com/Kataglyphis/ANThology