Skip to content

Commit

Permalink
Update @snowpack/app-template-minimal README, package.json (#1419)
Browse files Browse the repository at this point in the history
* Update @snowpack/app-template-minimal README, package.json

* Remove format and lint scripts

* Update snapshot

* Re-add test script
  • Loading branch information
drwpow authored Oct 27, 2020
1 parent 626b8fa commit 71f07ba
Show file tree
Hide file tree
Showing 3 changed files with 35 additions and 17 deletions.
30 changes: 19 additions & 11 deletions create-snowpack-app/app-template-minimal/README.md
Original file line number Diff line number Diff line change
@@ -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.
11 changes: 8 additions & 3 deletions create-snowpack-app/app-template-minimal/package.json
Original file line number Diff line number Diff line change
@@ -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"
],
Expand All @@ -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"
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -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\\"
],
Expand All @@ -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\\"
}
}"
`;
Expand Down

1 comment on commit 71f07ba

@vercel
Copy link

@vercel vercel bot commented on 71f07ba Oct 27, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.