https://github.com/taocode/sgw-11st-starter-kit
Source for www.sugargeneralwarning.com
https://github.com/taocode/sgw-11st-starter-kit
Last synced: about 2 months ago
JSON representation
Source for www.sugargeneralwarning.com
- Host: GitHub
- URL: https://github.com/taocode/sgw-11st-starter-kit
- Owner: taocode
- Created: 2021-06-14T13:19:58.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2021-06-17T20:51:17.000Z (almost 4 years ago)
- Last Synced: 2025-01-19T12:49:38.452Z (3 months ago)
- Language: HTML
- Size: 4.07 MB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 📦 11st-Starter-Kit
[](https://opensource.org/licenses/MIT)
[](https://app.netlify.com/sites/11st-starter-kit/deploys)
[11ty](https://www.11ty.dev/), powered by [Snowpack](https://www.snowpack.dev/)
with [Tailwind CSS](https://tailwindcss.com) and
[Alpine.js](https://github.com/alpinejs/alpine/).
## Install Dependencies
First, make sure you have `npm` (packaged with
[Node.js](https://nodejs.org)) installed, then run `npm run setup` to install
the dependencies and validate that everything is running correctly.
## Available Scripts
### Development
```bash
# runs the app in the development mode.
npm run dev
```
Open http://localhost:8080 to view it in the browser.
The page will reload if you make file changes.
### Production
To increase the production performance builds are optimized via
[@snowpack/plugin-optimize](https://github.com/pikapkg/snowpack/tree/master/plugins/plugin-optimize).
```bash
# builds a static copy of your site to the `dist/` folder.
npm run build
```
```bash
# serve the content from the `dist/` folder.
npm run serve
```
Open http://localhost:8080 to view it in the browser.
Your code is now ready to be deployed!
## Netlify
To get your own instance of this 11st-Starter-Kit cloned and deploying to
Netlify very quickly, just click the button below and follow the instructions.
[
](https://app.netlify.com/start/deploy?repository=https://github.com/stefanfrede/11st-starter-kit)
### Add some Netlify helpers
Netlify Dev adds the ability to use Netlify redirects, proxies, and serverless functions.
```bash
# install the Netlify CLI in order to get netlify dev
npm install -g netlify-cli
# run a local server with some added Netlify sugar
netlify dev
```
## Code Quality
By default `CSS` and `JavaScript` is getting linted with every commit.
You can lint manually by running `npm run lint` and if errors occur you can try to fix them automatically by running `npm run format`.
With every pull request it is checked if the code can be build without errors and afterwards `CSS` and `JavaScript` is getting linted.
Additionally each page is audited by Lighthouse which can take some time. You can find the performance budget for this audit in the file `./budget.json`.
## License
This project is open source and available under the [MIT License](LICENSE).