mirror of
https://github.com/Dan6erbond/sk-auth.git
synced 2024-10-15 20:06:24 +02:00
5d1802fea4
* 🎉 Scaffold example app with SvelteKit barebones skeleton * 💄 Add TWCSS and base styles with fonts Inter/Fira Mono * 🔧 Add `exports` and `types` to `package.json` and update `tsconfig.json` for Vite-compatible build output * ➕ Add local dependency to `svelte-kit-auth` as symlink * 🔧 Update example app env variables * ✨ Add basic auth config to example app * ♻️ Export all providers from `/providers` module * 🎨 Make `Auth` class default export of lib * 🚚 Rename `example-app` to `app` * ➕ Use `file:` instead of `link:` for local dependency to `svelte-kit-auth` * 🔧 Add `JWT_SECRET_KEY` to env and config * 🎨 Add `RedditOAuthProvider.profileHandler` for general use and stripping of payload * ✨ Export auth API routes from app * ⬆️ Update local deps * ✨ Add `host` and `basePath` to general config and improve recognition of routes * 🚨 Exclude `app` from TS build * 📌 Undo `file:` mapping dependency for usage with Vite TODO: Needs to be fixed for release. * 🎨 Enable TS `strict` mode and set target to `es2017` * 📌 Undo `file:` mapping dependency for usage with Vite * 🚨 Format and lint files * 🍱 Add logo * ✨ Add login and profile routes to example app for showcase and testing * 💄 Add PrismJS and create homepage with example * 🔨 Add `build:watch`
39 lines
1.0 KiB
Markdown
39 lines
1.0 KiB
Markdown
# create-svelte
|
|
|
|
Everything you need to build a Svelte project, powered by [`create-svelte`](https://github.com/sveltejs/kit/tree/master/packages/create-svelte);
|
|
|
|
## Creating a project
|
|
|
|
If you're seeing this, you've probably already done this step. Congrats!
|
|
|
|
```bash
|
|
# create a new project in the current directory
|
|
npm init svelte@next
|
|
|
|
# create a new project in my-app
|
|
npm init svelte@next my-app
|
|
```
|
|
|
|
> Note: the `@next` is temporary
|
|
|
|
## 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
|
|
|
|
Before creating a production version of your app, install an [adapter](https://kit.svelte.dev/docs#adapters) for your target environment. Then:
|
|
|
|
```bash
|
|
npm run build
|
|
```
|
|
|
|
> You can preview the built app with `npm run preview`, regardless of whether you installed an adapter. This should _not_ be used to serve your app in production.
|