vanilluis/sveltekit-tailwind-starter-1

A barebones starter kit for SvelteKit and TailwindCSS that includes: TypeScript, Prettier, ESLint, PostCSS, and SASS.

💻 🟦 SvelteKit + TailwindCSS Starter

A barebones SvelteKit starter that allows you to quickly scaffold a project with TailwindCSS.

⚙️ Installing this starter kit

# clone this repository
git clone [email protected]:bmkubia/sveltekit-tailwind-starter.git

# or install with npx degit
npx degit [email protected]:bmkubia/sveltekit-tailwind-starter.git

# enter your cloned folder and install dependencies
cd sveltekit-tailwind-starter && npm i

🛠 Developing your application

# start the development environment
npm run dev

# or start the server and open the app in a new browser tab
npm run dev -- --open

Note: you can also run npm run dev:host if you need to access the application on your local network.

Prettier

The project comes included with a .prettierrc file (only because I had the option that requires the file in your project on my VSCode), this may not suit your style and can easily be removed or replaced as needed.

TailwindCSS Config

I have left the tailwind.config.cjs fairly barebones, if you wish to extend the styling or add plugins please refer to the TailwindCSS documentation.

⚗️ Building your application

Before creating a production version of your app, you must install an adapter for your target environment. This starter kit does not come with an adapter pre-installed and gives you the freedom to add your own.

Once you have chosen your adapter you can build by running the following command:

# build application for production
npm run build

You can preview your built application with npm run preview, regardless of whether you have installed an adapter or not. However, keep in mind that this should not be used to serve your appplication in production.

📝 Contributing to this project

I built this mainly for myself to use because all of the starter kits that I tend to use are fairly bloated with things I find unnecessary (such as testing, yuck! /s). If you wish to contribute to the project feel free to open a PR or leave an Issue for something that you would want added in the future.

All code and contributions are under the MIT License.