Skip to content

Commit

Permalink
update readme (#1)
Browse files Browse the repository at this point in the history
  • Loading branch information
horvathandris committed Aug 10, 2024
1 parent 5d18bc1 commit bd45fe3
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 27 deletions.
36 changes: 10 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,14 @@
# create-svelte
# sveltekit-daisyui-template

Everything you need to build a Svelte project, powered by [`create-svelte`](https://github.com/sveltejs/kit/tree/main/packages/create-svelte).
This is a SvelteKit template with DaisyUI, a Tailwind CSS component library.

## Creating a project
## Features

If you're seeing this, you've probably already done this step. Congrats!
This template includes:

## Developing

Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:

```bash
pnpm dev

# or start the server and open the app in a new browser tab
pnpm dev
```

## Building

To create a production version of your app:

```bash
pnpm build
```

You can preview the production build with `pnpm preview`.

> To deploy your app, you may need to install an [adapter](https://kit.svelte.dev/docs/adapters) for your target environment.
- [SvelteKit](https://kit.svelte.dev/) with [TypeScript](https://www.typescriptlang.org/)
- [DaisyUI](https://daisyui.com/), a [Tailwind CSS](https://tailwindcss.com/) component library
- [ESLint](https://eslint.org/) and [Prettier](https://prettier.io/) for code linting and formatting
- [Storybook](https://storybook.js.org/) for component development
- [Husky](https://typicode.github.io/husky/) and [nano-staged](https://github.com/usmanyunusov/nano-staged) for pre-commit hooks
- [GitHub Actions](https://docs.github.com/en/actions) workflow for build, lint and test
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
"check:watch": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json --watch",
"lint": "prettier --check . && eslint .",
"format": "prettier --write . && eslint . --fix",
"prepare": "husky",
"prepare": "husky && svelte-kit sync",
"storybook": "storybook dev -p 6006",
"build-storybook": "storybook build",
"test": "echo \"Error: no test specified\""
Expand Down

0 comments on commit bd45fe3

Please sign in to comment.