Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/olliejt/starter-svelte
https://github.com/olliejt/starter-svelte
Last synced: 10 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/olliejt/starter-svelte
- Owner: OllieJT
- Created: 2021-04-25T21:07:08.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-01-03T23:22:24.000Z (about 1 year ago)
- Last Synced: 2024-01-04T01:31:41.576Z (about 1 year ago)
- Language: CSS
- Size: 1.66 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# About the project
```
npx degit OllieJT/starter-svelte
```
This is a [SvelteKit](https://kit.svelte.dev) project. You'll need node setup before you begin.
```bash
# install dependencies
npm install
```
## Developing
Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:
```bash
npm run dev
# or start the server and open the app in a new browser tab
npm run dev -- --open
```
## Building
To create a production version of your app:
```bash
npm run build
```
### npm scripts
| Syntax | Description |
| -------- | --------------------------------------------------------------- |
| `dev` | starts dev server |
| `build` | build app for production |
| `check` | checks project for best practices |
| `format` | format files with Prettier |
| `lint` | checks for linting and formatting issues with Prettier & Eslint |
| `ts` | checks for typescript errors |
## Useful Docs
| Package | Description |
| ------------------------------------------------------------ | ---------------------------------------- |
| [Svelte](https://svelte.dev/docs) | Frontend framework |
| [Svelte Kit](https://kit.svelte.dev/docs) | Fullstack meta-framework |
| [sveltekit-superforms](https://superforms.vercel.app/api) | Easy form data handling with type-safety |
| [zod](https://zod.dev/?id=primitives) | Runtime type checking |
| [date-fns](https://date-fns.org/v2.29.3/docs/formatRelative) | Easy date formatting and utilities |
## Comments
```js
// KEY: Comment details
```
| Key | Description |
| ----- | ------------------------------------------------------------------------------------------------------------------------------ |
| BUG | Highlights a known bug in the code that needs fixing. |
| HACK | Indicates that a certain piece of code is a workaround or a temporary solution that bypasses the issue rather than solving it. |
| FIXME | A section of code that doesn't work as it should and needs to be fixed. |
| TODO | A reminder that there is some piece of code or functionality that still needs to be implemented or finished. |
| FEAT | A section where a new feature needs to be implemented. |
| [ ] | An incomplete checklist item. Typically used for subtasks within a larger project. |
| [x] | An complete checklist item. |