rust-learning-microsoft

KO | EN

gitlite — search

#typescript #golang #machine-learning #rust #deep-learning #macos #awesome #vue #security #pytorch #mcp #ios #openai #open-source

rust-learning-microsoft

(★ 38)

No description available.

rust-learning-microsoft Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# 🦀 Rust Training — Microsoft

A modern web reader for [Microsoft's Rust Training](https://github.com/microsoft/RustTraining) books, plus **[100 Rust Projects](https://github.com/emmaglorypraise/100rustprojects)** by [Glory Praise Emmanuel](https://github.com/emmaglorypraise). Eight library entries — seven Microsoft books and one hands-on project collection covering CLI through async, web, and databases.

**Live site →** [https://rust.learningz.xyz/](https://rust.learningz.xyz/)

Built by [Ruhan Khandakar](https://x.com/KhandakarRuhan).

## Features

- **8 library entries** (7 Microsoft books + **100 Rust Projects**) with chapter-by-chapter navigation and syntax highlighting
- **Offline support** — PWA with automatic chapter caching
- **Reading progress** — auto-tracked per chapter with visual progress bars
- **Bookmarks** — bookmark any heading in any chapter for quick access
- **Cloud sync** — sign in with GitHub to sync progress, bookmarks, and preferences across devices
- **Customizable reading** — 5 font families, 4 size options, dark/light theme
- **Full-text search** — fuzzy search across all books via `⌘K`
- **Mobile-friendly** — responsive design with collapsible sidebar and mobile nav

## Tech Stack

- **Framework:** [Next.js 16](https://nextjs.org) (App Router, SSG)
- **Styling:** [Tailwind CSS v4](https://tailwindcss.com) + [shadcn/ui](https://ui.shadcn.com)
- **Auth:** [Better Auth](https://better-auth.com) (GitHub OAuth)
- **Database:** [Turso](https://turso.tech) (libSQL) + [Kysely](https://kysely.dev) migrations
- **Offline:** Custom service worker + IndexedDB
- **Search:** [FlexSearch](https://github.com/nicxleo/flexsearch)
- **Markdown:** react-markdown + remark-gfm + rehype-highlight

## Getting Started

### Prerequisites

- Node.js 18+
- [pnpm](https://pnpm.io)

### Setup

```bash
# Clone the repo
git clone https://github.com/ruhankhandakar/rust-learning-microsoft.git
cd rust-learning-microsoft

# Install dependencies
pnpm install

# Copy env template and fill in your values
cp .env.example .env.local
```

### Environment Variables

| Variable | Description | Where to get it |
|---|---|---|
| `GITHUB_CLIENT_ID` | GitHub OAuth app client ID | [GitHub Developer Settings](https://github.com/settings/developers) |
| `GITHUB_CLIENT_SECRET` | GitHub OAuth app client secret | Same as above |
| `TURSO_DATABASE_URL` | Turso database URL | [Turso Dashboard](https://turso.tech) |
| `TURSO_AUTH_TOKEN` | Turso auth token | Same as above |
| `BETTER_AUTH_SECRET` | Random secret for auth sessions | `openssl rand -base64 32` |
| `BETTER_AUTH_URL` | Base URL of your app | `http://localhost:3000` for dev |

> **Note:** The app works without these env vars — you just won't have cloud sync / GitHub login. All features (reading, bookmarks, progress, fonts) work locally via IndexedDB and localStorage.

### Database Setup

```bash
# Run migrations (creates better-auth tables + reading_progress + user_preferences + bookmarks)
pnpm db:migrate
```

### Development

```bash
pnpm dev
```

### Production Build

```bash
pnpm build
pnpm start
```

## Project Structure

```
app/
├── page.tsx                          # Homepage
├── books/[bookSlug]/page.tsx         # Book landing page
├── books/[bookSlug]/[chapterSlug]/   # Chapter reading page
├── api/auth/[...all]/                # Better Auth handler
├── api/progress/                     # Reading progress API
├── api/preferences/                  # User preferences API
├── api/bookmarks/                    # Bookmarks API
├── api/search/                       # Search index API
├── manifest.ts                       # PWA manifest
├── globals.css                       # Tailwind + theme
├── layout.tsx                        # Root layout with providers

components/
├── settings-dropdown.tsx             # Unified settings (theme, font, auth, bookmarks)
├── bookmark-provider.tsx             # Bookmark context + IndexedDB + cloud sync
├── font-provider.tsx                 # Font context + cloud sync
├── theme-provider.tsx                # Theme context + cloud sync
├── progress-provider.tsx             # Reading progress context + cloud sync
├── markdown-renderer.tsx             # Markdown with copy buttons + bookmark-able headings
├── search-dialog.tsx                 # ⌘K search
└── ...

db/
├── index.ts                          # Kysely instance + types
├── migrate.ts                        # Migration runner
└── migrations/                       # Kysely migrations

lib/
├── books.ts                          # Book metadata
├── content.ts                        # SUMMARY.md parser + markdown reader
├── auth.ts                           # Better Auth server config
├── auth-client.ts                    # Better Auth client
├── preferences.ts                    # Preferences API helpers
├── bookmarks-db.ts                   # IndexedDB for bookmarks
├── progress-db.ts                    # IndexedDB for progress
└── version.ts                        # App version from package.json

public/
├── sw.js                             # Service worker
├── content-hash.json                 # Auto-generated content hash for cache busting
└── icons/                            # PWA icons

scripts/
├── sync-content.sh                   # Pull latest markdown from upstream repo
├── generate-content-hash.js          # Hash content for SW cache invalidation
└── sync-sw-version.js                # Sync package.json version → SW cache name

.github/workflows/
└── sync-content.yml                  # Weekly automated content sync (PR-based)
```

## Content Sync

Book content is sourced from [microsoft/RustTraining](https://github.com/microsoft/RustTraining). A GitHub Actions workflow syncs it automatically every Monday and opens a PR for review.

### How it works

1. `scripts/sync-content.sh` shallow-clones the upstream repo and rsyncs `.md` files from each book's `src/` into `content/<book>/`
2. If anything changed, the workflow bumps the patch version, regenerates the content hash and SW cache name, then opens a PR
3. You review and merge — Vercel deploys, the new SW activates and invalidates the old cache

### Manual sync

```bash
pnpm sync-content          # Pull latest from upstream
node scripts/generate-content-hash.js  # Regenerate content hash
```

### Triggering the workflow manually

Go to **Actions → Sync upstream content → Run workflow** in the GitHub repo.

## Versioning & Service Worker

`package.json` is the single source of truth for the app version. The build script auto-syncs it to the service worker cache name and generates a `content-hash.json` for fine-grained cache invalidation.

```bash
pnpm version:patch   # 1.0.0 → 1.0.1
pnpm version:minor   # 1.0.0 → 1.1.0
pnpm version:major   # 1.0.0 → 2.0.0
```

The SW uses a **network-first** strategy for pages and a **cache-first** strategy for static assets. On deploy, a new version-stamped cache replaces the old one. The `CHECK_CONTENT_UPDATE` message lets the app detect content changes and notify users without a full SW update.

## Contributing

Contributions are welcome! If you find a bug or want to add a feature:

1. Fork the repo
2. Create a feature branch (`git checkout -b feat/my-feature`)
3. Commit your changes
4. Open a PR

For content issues, please file them on [microsoft/RustTraining](https://github.com/microsoft/RustTraining/issues) directly.

## License

MIT — see [LICENSE](./LICENSE).

Training content is from [microsoft/RustTraining](https://github.com/microsoft/RustTraining) under MIT & CC BY 4.0.

rust-learning-microsoft

rust-learning-microsoft Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

rust-learning-microsoft

rust-learning-microsoft Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README