Getting Started
This page explains how to fetch and run PubPub locally.
Requirements
- Flutter 3.41 or newer
- Dart 3.11 or newer
- Windows desktop development requires Visual Studio 2022 (with the "Desktop development with C++" workload)
Get the source
bash
git clone https://github.com/Maicarons/pubpub.git
cd pubpubInstall dependencies and generate code
bash
# Install Flutter dependencies
flutter pub get
# Generate JSON serialization code
flutter pub run build_runner buildRun
bash
flutter run -d windows # Windows
flutter run -d android # Android
flutter run -d chrome # WebBuild a release
bash
flutter build windows
flutter build apk
flutter build webData sources
The app defaults to the China mirror https://pub.flutter-io.cn. You can switch to the official source https://pub.dev/api or another mirror in Settings. See API.
Preview the docs site locally
The documentation is built with VitePress and can be previewed locally:
bash
npm install
npm run docs:devBuild the static site:
bash
npm run docs:buildNext steps
- Learn the Architecture
- Contribute via Development
- Explore Localization