From 71f07ba6e5e34c2c349f9fed3297130e4da2c15f Mon Sep 17 00:00:00 2001 From: Drew Powers <1369770+drwpow@users.noreply.github.com> Date: Tue, 27 Oct 2020 12:04:01 -0600 Subject: [PATCH] Update @snowpack/app-template-minimal README, package.json (#1419) * Update @snowpack/app-template-minimal README, package.json * Remove format and lint scripts * Update snapshot * Re-add test script --- .../app-template-minimal/README.md | 30 ++++++++++++------- .../app-template-minimal/package.json | 11 +++++-- .../create-snowpack-app.test.js.snap | 11 +++++-- 3 files changed, 35 insertions(+), 17 deletions(-) diff --git a/create-snowpack-app/app-template-minimal/README.md b/create-snowpack-app/app-template-minimal/README.md index 80fbd8aef4..975b5389d1 100644 --- a/create-snowpack-app/app-template-minimal/README.md +++ b/create-snowpack-app/app-template-minimal/README.md @@ -1,16 +1,24 @@ -# app-template-minimal +# New Project -A bare bones Snowpack animal that serves a webpage and its resources. +> ✨ Bootstrapped with Create Snowpack App (CSA). -## App files +## Available Scripts -- `index.html`: a simple webpage that includes `index.css` and `index.js` -- `index.js`: a simple JavaScript file that prints "hello world" to the console -- `index.css`: a simple CSS file with some global styles -- `snowpack.config.js`: an example Snowpack config file -- `package.json`: with Snowpack installed as a development dependency and scripts for starting and building +### npm start -## Using this App +Runs the app in the development mode. +Open http://localhost:8080 to view it in the browser. -- Run `npm start` to start the dev server. Updates to the code will show instantly. -- Run `npm build` to build for production. +The page will reload if you make edits. +You will also see any lint errors in the console. + +### npm run build + +Builds a static copy of your site to the `build/` folder. +Your app is ready to be deployed! + +**For the best production performance:** Add a build bundler plugin like [@snowpack/plugin-webpack](https://github.com/snowpackjs/snowpack/tree/master/plugins/plugin-webpack) or [snowpack-plugin-rollup-bundle](https://github.com/ParamagicDev/snowpack-plugin-rollup-bundle) to your `snowpack.config.json` config file. + +### Q: What about Eject? + +No eject needed! Snowpack guarantees zero lock-in, and CSA strives for the same. diff --git a/create-snowpack-app/app-template-minimal/package.json b/create-snowpack-app/app-template-minimal/package.json index cad86054c2..41c053e903 100644 --- a/create-snowpack-app/app-template-minimal/package.json +++ b/create-snowpack-app/app-template-minimal/package.json @@ -1,9 +1,14 @@ { "name": "@snowpack/app-template-minimal", "description": "A preconfigured minimal template for Snowpack", - "private": true, - "version": "1.6.12", + "version": "1.0.1", "license": "MIT", + "homepage": "https://github.com/snowpackjs/snowpack/tree/master/create-snowpack-app/app-template-preact#readme", + "repository": { + "type": "git", + "url": "https://github.com/snowpackjs/snowpack.git", + "directory": "create-snowpack-app/app-template-minimal" + }, "keywords": [ "csa-template" ], @@ -14,6 +19,6 @@ "test": "echo \"This template does not include a test runner by default.\" && exit 1" }, "devDependencies": { - "snowpack": "^2.14.3" + "snowpack": "^2.15.1" } } diff --git a/test/create-snowpack-app/__snapshots__/create-snowpack-app.test.js.snap b/test/create-snowpack-app/__snapshots__/create-snowpack-app.test.js.snap index daf8d4f1c2..c5abee948b 100644 --- a/test/create-snowpack-app/__snapshots__/create-snowpack-app.test.js.snap +++ b/test/create-snowpack-app/__snapshots__/create-snowpack-app.test.js.snap @@ -7351,9 +7351,14 @@ exports[`create-snowpack-app app-template-minimal > build: package.json 1`] = ` "{ \\"name\\": \\"@snowpack/app-template-minimal\\", \\"description\\": \\"A preconfigured minimal template for Snowpack\\", - \\"private\\": true, - \\"version\\": \\"1.6.12\\", + \\"version\\": \\"1.0.1\\", \\"license\\": \\"MIT\\", + \\"homepage\\": \\"https://github.com/snowpackjs/snowpack/tree/master/create-snowpack-app/app-template-preact#readme\\", + \\"repository\\": { + \\"type\\": \\"git\\", + \\"url\\": \\"https://github.com/snowpackjs/snowpack.git\\", + \\"directory\\": \\"create-snowpack-app/app-template-minimal\\" + }, \\"keywords\\": [ \\"csa-template\\" ], @@ -7364,7 +7369,7 @@ exports[`create-snowpack-app app-template-minimal > build: package.json 1`] = ` \\"test\\": \\"echo \\\\\\"This template does not include a test runner by default.\\\\\\" && exit 1\\" }, \\"devDependencies\\": { - \\"snowpack\\": \\"^2.14.3\\" + \\"snowpack\\": \\"^2.15.1\\" } }" `;