/11st-starter-kit

11ty, powered by Snowpack with Tailwind CSS and Alpine.js.

Primary LanguageHTML

📦 11st-Starter-Kit

License: MIT Netlify Status

11ty, powered by Snowpack with Tailwind CSS and Alpine.js.

Install Dependencies

First, make sure you have npm (packaged with Node.js) installed, then run npm run setup to install the dependencies and validate that everything is running correctly.

Available Scripts

Development

# 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.

# builds a static copy of your site to the `dist/` folder.
npm run build
# 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.

Add some Netlify helpers

Netlify Dev adds the ability to use Netlify redirects, proxies, and serverless functions.

# 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.