preactjs/preact-www

Tutorial: Building an app with Preact CLI

Open

#152 opened on Aug 2, 2017

View on GitHub
 (5 comments) (10 reactions) (0 assignees)JavaScript (519 forks)github user discovery
help wanted

Repository metrics

Stars
 (380 stars)
PR merge metrics
 (PR metrics pending)

Description

Now that Preact CLI is listed over on the PWA page, it would be 💯 to give developers a clean walk-through they can follow for building their first app using Preact CLI.

A tutorial could replicate building the Weather PWA with Preact CLI or something quite different if we need an app that is more complex, like something using the Hacker News or Wikipedia APIs.

Draft task list:

  • Decide on the app the tutorial would help you build
  • Decide if the tutorial will cover deploying H/2 Server Push (Firebase static hosting?)
  • Write the app we will show developers how to build and validate it's suitable for the tutorial
  • Draft tutorial. Show folks how to validate features + performance are ✔️ using Lighthouse ⚡️
  • Review (perhaps have some Preact community members try it out?) 🤔
  • Ship it! 🚢

Looping in some folks for their thoughts: @lukeed @kristoferbaxter

Contributor guide

Research direction
Review the existing Preact CLI documentation and PWA page. Decide on a sample app (e.g., Weather PWA or Hacker News). Outline the tutorial steps, build the app, and ensure performance using Lighthouse. Then draft the tutorial and seek community review.
Tech stack
javascript
Domain
documentationweb dev
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitPreact CLI basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85