actions / actions/starter-workflows
> This issue creates the Release OfflineBookDatabasePro v1.0.0 and adds the required files for the release: README.md, .gitignore, Git tag & release steps, and GitHub Actions workflow for APK and Windows builds.
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 12.1k
- Forks
- 7.3k
- PR merge metrics
- No merged PRs in 30d
Description
This issue creates the Release OfflineBookDatabasePro v1.0.0 and adds the required files for the release: README.md, .gitignore, Git tag & release steps, and GitHub Actions workflow for APK and Windows builds.
Files to add / include in repository:
- README.md
📚 OfflineBookDatabasePro
Personal Offline Knowledge Library System
OfflineBookDatabasePro is a professional offline-first digital library application built with Flutter and SQLite.
It helps users store, organize, search, read, and protect their personal book collections.
✨ Features
📚 Library Management
- Book collection management
- Category organization
- Author information
- Cover management
🔍 Smart Search
- Myanmar Unicode search
- English search
- Fast SQLite indexing
- Category filtering
📖 Reading System
- Continue reading
- Bookmark
- Notes
- Reading history
🔒 Private Vault
- PIN protection
- Private book storage
- Local security layer
🤖 AI Assistant Ready
- Local knowledge search
- Book reference system
- Future GPT integration
💾 Offline First
- No internet required
- SQLite local database
- Local file storage
🏗 Architecture
Flutter UI
↓
Services Layer
↓
SQLite Database
↓
Local Storage
📱 Supported Platforms
Platform Status
Android Ready
Windows Ready
Web Ready
iOS Planned🛠 Development
Requirements:
- Flutter SDK 3+
- Dart SDK 3+
- Android Studio
- VS Code
Install packages:
flutter pub get
Run:
flutter run
Build ReleaseAndroid APK
flutter build apk --release
Windowsflutter build windows --release
Webflutter build web --release
🔐 SecurityOffline data storage
No unnecessary permissions
No tracking SDK
Local database protection
📦 Version
Current Release:
v1.0.0
License
MIT License
- .gitignore
.gitignore contents:
Flutter
.dart_tool/
.packages
.pub/
build/IDE
.idea/
.vscode/
*.imlAndroid
android/.gradle/
android/local.properties
*.jks
*.keystoreiOS
ios/Pods/
ios/.symlinks/
ios/Flutter/Flutter.frameworkWindows
windows/flutter/ephemeral/
Secrets
.env
*.key
*.pemDatabase private files
*.db
*.sqliteUser data
/private/
backup/Generated files
*.log
3. Git Release Tag v1.0.0 (terminal + GitHub Release)Terminal commands to create the tag and push:
git add .
git commit -m "Release OfflineBookDatabasePro v1.0.0"
git tag -a v1.0.0 -m "OfflineBookDatabasePro first stable release"
git push origin main
git push origin v1.0.0
GitHub Release (manual steps):On GitHub → Releases → Create Release
Tag: v1.0.0
Title: OfflineBookDatabasePro v1.0.0
Description: First production release
- GitHub Actions Build Script
Path: .github/workflows/build.yml
Contents:
name: Build OfflineBookDatabasePro
on:
push:
tags:
- "v*"jobs:
android-build:
name: Android APK Build
runs-on: ubuntu-latest
steps:
- name: Checkout Code
uses: actions/checkout@v4- name: Setup Flutter uses: subosito/flutter-action@v2 with: flutter-version: "3.22.0" - name: Install Packages run: flutter pub get - name: Build APK run: flutter build apk --release - name: Upload APK uses: actions/upload-artifact@v4 with: name: OfflineBookDatabasePro-APK path: build/app/outputs/flutter-apk/app-release.apkwindows-build:
name: Windows Build
runs-on: windows-latest
steps:
- uses: actions/checkout@v4- uses: subosito/flutter-action@v2 with: flutter-version: "3.22.0" - run: flutter pub get - run: flutter build windows --release - uses: actions/upload-artifact@v4 with: name: OfflineBookDatabasePro-Windows path: build/windows/x64/runner/ReleaseFinal GitHub Repository State (expected):
OfflineBookDatabasePro v1.0.0 Release
✅ README.md ✅ .gitignore ✅ Git Tag ✅ GitHub Actions ✅ APK Build Automation ✅ Windows Build Automation
Notes:
- This issue adds the files and release instructions necessary to publish OfflineBookDatabasePro v1.0.0.
- No assignees, labels, or milestone specified. Add labels/assignees if desired.
Finish
Originally posted by @Hubbbjj in https://github.com/Hubbbjj/studious-robot/issues/2#issuecomment-5055981521
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by checking whether README.md, .gitignore, and .github/workflows/build.yml belong in this repository or in the referenced studious-robot issue. Review the requested Flutter 3.22.0 APK and Windows build commands, then verify that the v1.0.0 tag and both workflow artifacts are produced as described.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- flutter, git, github-actions, sqlite
- Domain
- build-system, ci-cd, release
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100