List of cities for Strascrous | Mirror from https://github.com/Strascrous/Data
  • TypeScript 79.3%
  • Dart 20.7%
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
2026-11-15 23:29:30 +01:00
.github/workflows chore(workflow): use app flutter version 2026-11-15 23:22:39 +01:00
data chore: add gps coords to yaml 2026-11-05 09:20:56 +01:00
schema chore: add gps coords to yaml 2026-11-05 09:20:56 +01:00
scripts feat(ts): add location to typescript lib 2026-11-15 23:18:41 +01:00
templates fix(ts): reexport cities 2026-11-15 23:29:30 +01:00
.gitignore chore: init libraries template 2026-11-02 23:26:58 +01:00
bun.lock chore: upgrade packages 2026-11-08 17:09:51 +01:00
LICENSE chore: README 2026-11-08 18:47:37 +01:00
package-lock.json feat: dart generation 2026-11-02 23:53:23 +01:00
package.json chore: upgrade packages 2026-11-08 17:09:51 +01:00
README.md chore(README): less verbosity 2026-11-08 18:48:17 +01:00
tsconfig.json chore: init libraries template 2026-11-02 23:26:58 +01:00

Strascrous Data

Données des villes partagées entre l’application Flutter et l’API Strascrous. Ce dépôt génère deux bibliothèques : @strascrous/data pour TypeScript et strascrous_data pour Flutter.

Prérequis

Installation et génération

npm ci
npm run generate

Les bibliothèques sont générées dans dist/ts/ et dist/dart/.

Utilisation

TypeScript

Installer la bibliothèque :

npm install 'git+https://github.com/Strascrous/Data.git#generated/ts'
import { cities, findCityById } from '@strascrous/data';

console.log(cities);
console.log(findCityById('strasbourg')?.areas);

Flutter

Ajouter la dépendance dans pubspec.yaml :

dependencies:
    strascrous_data:
        git:
            url: https://github.com/Strascrous/Data.git
            ref: generated/dart

Puis lancer flutter pub get et importer la bibliothèque :

import 'package:strascrous_data/strascrous_data.dart';

final city = cities.firstWhere((city) => city.id == 'strasbourg');

Développement

Les villes sont définies dans data/cities.yaml, regroupées par académie. Les données sont validées à la génération par le schéma.

Il existe deux sources pour les icônes:

Vérifier les bibliothèques générées

Après génération :

# TypeScript
(cd dist/ts && npm ci && npm run build)

# Flutter
(cd dist/dart && flutter pub get && flutter analyze)

Distribution

La publication d’une release GitHub déclenche la génération, les vérifications et la distribution sur les branches generated/ts et generated/dart.

Organisation du projet

data/                        # Villes par académie
schema/                      # Schéma de validation
scripts/                     # Génération et versionnement
templates/
├── dart/                    # Modèle Flutter
└── ts/                      # Modèle TypeScript
dist/                        # Bibliothèques générées
.github/workflows/           # Distribution automatique

Licence

Ce projet est sous licence MIT.

Les icônes Material Design Icons sont sous licence Apache 2.0, incluse dans la bibliothèque Flutter générée.