Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Staging to Main #4320

Merged
merged 32 commits into from
Sep 20, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
e2f4f8f
[PWABuilder] Color Picker fix, Dark theme Android (#4309) (#4319)
jgw96 Aug 24, 2023
48915b8
update to AI test
Jaylyn-Barbee Aug 24, 2023
b121850
Merge branch 'staging' of github.com:pwa-builder/PWABuilder into staging
Jaylyn-Barbee Aug 24, 2023
e13e091
Merge branch 'main' into staging
jgw96 Aug 24, 2023
b792419
AI test
Jaylyn-Barbee Aug 24, 2023
bab8b01
Merge branch 'staging' of github.com:pwa-builder/PWABuilder into staging
Jaylyn-Barbee Aug 24, 2023
50e7f42
reset from AI test moving to branch
Jaylyn-Barbee Aug 24, 2023
36d8b7c
[Accessibility] fixed header hierarchy issues (#4325)
Jaylyn-Barbee Aug 28, 2023
ee8bbef
[Accessibility] fixed page title issue (#4327)
Jaylyn-Barbee Aug 28, 2023
fd6950d
Merge branch 'main' into staging
jgw96 Aug 28, 2023
701704b
[Accessibility] Removed close button from portals modal (#4326)
Jaylyn-Barbee Aug 28, 2023
3b42d07
[Accessibility] Fix to radios and checkboxes not being associated wit…
Jaylyn-Barbee Aug 29, 2023
fbc8643
[Accessibility] Fixed focus no appearing on black buttons and label o…
Jaylyn-Barbee Aug 30, 2023
a0496cc
[Accessibility] Updates to the action items prev and next buttons (#4…
Jaylyn-Barbee Aug 30, 2023
0254a4a
[Accessibility] Errors are announced as the appear in the manifest ed…
Jaylyn-Barbee Aug 30, 2023
994f6c1
[Accessibility][Docs] Fixed issue of github link not showing text whe…
Jaylyn-Barbee Aug 30, 2023
d8a5262
color ratio fix (#4344)
maraah1 Sep 5, 2023
7ab252d
Merge branch 'main' into staging
jgw96 Sep 5, 2023
96867ee
docs(manifest): correct web app origin association (#4366)
dargmuesli Sep 8, 2023
12960cd
fix(typo): `handle_links` error message (#4376)
SirajChokshi Sep 13, 2023
5c328df
[CLI][DO NOT MERGE] CLI Initial Release (#3980)
zateutsch Sep 13, 2023
5f6beb2
[CLI] Documentation update for CLI release (#4372)
zateutsch Sep 13, 2023
9917eca
[CLI] CLI release notes (#4373)
zateutsch Sep 13, 2023
90e417a
[BLOG][CLI][DO NOT MERGE] Announcing CLI Blog Post (#3979)
zateutsch Sep 13, 2023
570a90a
required label add (#4368)
maraah1 Sep 18, 2023
6f26ed1
[Site] fall back for no manifest (#4381)
Jaylyn-Barbee Sep 18, 2023
fce35f9
[SITE] remove giveaway references from the report card page (#4380)
Jaylyn-Barbee Sep 18, 2023
fb6f8e7
fixed display on mobile for end of campaign page
Jaylyn-Barbee Sep 18, 2023
cd87a77
[DOCS] Remove docs related to promotion (#4377)
zateutsch Sep 18, 2023
10cd849
docs(manifest): correct `launch-handler` array (#4365)
dargmuesli Sep 18, 2023
eccd2f3
Merge branch 'staging' of github.com:pwa-builder/PWABuilder into staging
Jaylyn-Barbee Sep 18, 2023
bb7bc11
[CLI] Change Usage Tracking Behavior (#4379)
zateutsch Sep 19, 2023
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
168 changes: 84 additions & 84 deletions .github/workflows/cli-main.yml
Original file line number Diff line number Diff line change
@@ -1,84 +1,84 @@
name: PWABuilder CLI Main CI/CD
on:
push:
paths:
-"apps/cli/**"
branches:
-main
-starter-cli-dev
pull_request:
paths:
-"apps/cli/**"
branches:
-main
-starter-cli-dev
workflow_dispatch:
jobs:
version:
runs-on: ubuntu-latest
defaults:
run:
working-directory: apps/cli
outputs:
latest-version: ${{steps.latest-version.outputs.version}}
package-version: ${{steps.package-version.outputs.current-version}}
strategy:
matrix:
node-version: [16.x]
steps:
- uses: actions/checkout@v2
- name: Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v1
with:
node-version: ${{ matrix.node-version }}
registry-url: 'https://registry.npmjs.org'
- name: Get latest version from npm
id: latest-version
run: echo ::set-output name=version::$(npm show @pwabuilder/cli version)
- name: Get current package version
id: package-version
uses: martinbeentjes/npm-get-version-action@master
publish:
runs-on: ubuntu-latest
needs: version
if: needs.version.outputs.latest-version != needs.version.outputs.package-version
defaults:
run:
working-directory: apps/cli
steps:
# Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
- uses: actions/checkout@v3
# Setup .npmrc file to publish to npm
- uses: actions/setup-node@v3
with:
node-version: '16.x'
registry-url: 'https://registry.npmjs.org'
- name: Replace tokens
# You may pin to the exact commit or the version.
# uses: cschleiden/replace-tokens@4f7e3d67f3ff2317ae650842145cdbaefba65189
uses: cschleiden/replace-tokens@v1.1
with:
files: '["**/usage-analytics.ts"]'
env:
ANALYTICS_CODE: ${{secrets.CLI_ANALYTICS_CODE}}
- name: Build
run: |
npm install
- name: Publish
run: npm publish
env:
NODE_AUTH_TOKEN: ${{ secrets.NPM_PUBLISH }}
name: PWABuilder CLI Main CI/CD

on:
push:
paths:
-"apps/cli/**"
branches:
-main
-starter-cli-dev
pull_request:
paths:
-"apps/cli/**"
branches:
-main
-starter-cli-dev
workflow_dispatch:

jobs:
version:
runs-on: ubuntu-latest
defaults:
run:
working-directory: apps/cli

outputs:
latest-version: ${{steps.latest-version.outputs.version}}
package-version: ${{steps.package-version.outputs.current-version}}

strategy:
matrix:
node-version: [16.x]

steps:
- uses: actions/checkout@v2

- name: Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v1
with:
node-version: ${{ matrix.node-version }}
registry-url: 'https://registry.npmjs.org'

- name: Get latest version from npm
id: latest-version
run: echo ::set-output name=version::$(npm show @pwabuilder/cli version)

- name: Get current package version
id: package-version
uses: martinbeentjes/npm-get-version-action@master

publish:
runs-on: ubuntu-latest
needs: version
if: needs.version.outputs.latest-version != needs.version.outputs.package-version
defaults:
run:
working-directory: apps/cli

steps:
# Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
- uses: actions/checkout@v3

# Setup .npmrc file to publish to npm
- uses: actions/setup-node@v3
with:
node-version: '16.x'
registry-url: 'https://registry.npmjs.org'

- name: Replace tokens
# You may pin to the exact commit or the version.
# uses: cschleiden/replace-tokens@4f7e3d67f3ff2317ae650842145cdbaefba65189
uses: cschleiden/replace-tokens@v1.1
with:
files: '["**/usage-analytics.ts"]'
env:
ANALYTICS_CODE: ${{secrets.CLI_ANALYTICS_CODE}}

- name: Build
run: |
npm install

- name: Publish
run: npm publish
env:
NODE_AUTH_TOKEN: ${{ secrets.NPM_PUBLISH }}
3 changes: 0 additions & 3 deletions .github/workflows/pwabuilder-preview.yml
Original file line number Diff line number Diff line change
Expand Up @@ -54,9 +54,6 @@ jobs:
run: |
npm install
npm run build

- name: Run Accessibility Insights CLI
run: npx accessibility-insights-cli --url "https://www.pwabuilder.com"

- name: 🚀 Deploy
id: builddeploy
Expand Down
52 changes: 52 additions & 0 deletions apps/blog/src/posts/announcing-cli/announcing-cli.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
---
layout: post
title: Use the PWABuilder CLI to Create a New Progressive Web App
excerpt: Announcing PWABuilder's new CLI. Create, develop, and test from an easy-to-use PWA template.
description: Announcing PWABuilder's new CLI. Create, develop, and test from an easy-to-use PWA template.
date: 2023-04-19
updatedDate: 2023-04-19
trending: true
featured: true
image:
isPost: true
backUrl: '/'
author:
name: Zach Teutsch
twitter: https://twitter.com/devteutsch
title: PWABuilder Engineer
tags:
- CLI
- PWA Starter
- PWA
- PWA template
---

PWABuilder is launching a brand new CLI that can create a new templated [Progressive Web App](https://docs.pwabuilder.com/#/home/pwa-intro) for you and have you developing in just seconds.
The CLI makes use of our existing [PWA Starter template](https://docs.pwabuilder.com/#/home/pwa-intro) to give you a lightweight groundwork to start building your first progressive web app on. We wanted to make sure that developers can dive in with development as quickly and as smoothly as possible.

You’ll need [NPM](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) to get started, and you can install the CLI globally with this command:

```
npm install -g @pwabuilder/cli
```

From there, it’s just one command to create your first app:

```
pwa create my-first-pwa
```

<img src="pwa-create.png.png" alt="PWABuilder CLI create command output after executing."></img>

And then one more command to start running and developing your app, with live-reload for changes!

```
pwa start
```

Your PWA will then open in the browser window!

<img src="open-pwa.png" alt="PWA Starter open in a new browser window."></img>


For more guidance on using the CLI, check out our documentation [here.](https://docs.pwabuilder.com/#/starter/quick-start) For feedback and issues, head over to our [Github repo](https://github.com/pwa-builder/PWABuilder). We’re always open ideas and direct contributions from the community!
Binary file added apps/blog/src/posts/announcing-cli/open-pwa.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added apps/blog/src/posts/announcing-cli/pwa-create.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
66 changes: 66 additions & 0 deletions apps/cli/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
# PWABuilder CLI

The [PWABuilder](https://www.pwabuilder.com/) CLI allows you to create a new Progressive Web App from the command line.

## Installing

To install with npm:

`npm install -g @pwabuilder/cli`

The `-g` flag indicates a global installation and will allow you to use the CLI from any directory.

## Basic Usage

## create

The CLI's primary purpose to create new Progressive Web Apps. To create a new app, open a command line of your choice and run:

`pwa create`

This command will prompt you for a name, but you can skip prompting by providing a name:

`pwa create <app-name>`

### Using Templates

PWABuilder currently offers two different PWA templates:

* **default** - The original PWA Starter template. This template has [full documentation]() available and is our recommended choice.
* **basic** - A simplified version of the PWA Starter template. This template has fewer dependencies and is closer to VanillaJS than the default template.

You can specify a template with the `-t|--template` option:

`pwa create <app-name> -t=basic`

## start

When run from a valid PWA Starter directory, the start command will use Vite to host your PWA on a development server:

`pwa start`

You can pass arguments to vite with the `--viteArgs` options:

`pwa start --viteArgs="<argument string here>"`

See [Vite's Config Reference](https://vitejs.dev/config/) for more details.

## build

When run from a valid PWA Starter directory, the build command will use Vite to build and pack your app for production:

`pwa build`

You can pass arguments to Vite with the `--viteArgs` options:

`pwa build --viteArgs="<argument string here>"`

See [Vite's Config Reference](https://vitejs.dev/config/) for more details.

## Resources

* [PWABuilder Website](https://www.pwabuilder.com/)

* [Full PWABuilder Documentation](https://docs.pwabuilder.com/#/)

* [PWA Starter Documentation](https://docs.pwabuilder.com/#/starter/quick-start)
Loading
Loading