https://github.com/timalanfarrow/kratos-selfservice-ui-vue3-typescript
This repository contains a reference implementation for Ory Kratos' in Vue3 / Vite with Typescript. It implements all Ory Kratos flows (login, registration, account settings, account recovery, account verification).
https://github.com/timalanfarrow/kratos-selfservice-ui-vue3-typescript
Last synced: 2 months ago
JSON representation
This repository contains a reference implementation for Ory Kratos' in Vue3 / Vite with Typescript. It implements all Ory Kratos flows (login, registration, account settings, account recovery, account verification).
- Host: GitHub
- URL: https://github.com/timalanfarrow/kratos-selfservice-ui-vue3-typescript
- Owner: timalanfarrow
- Created: 2022-02-09T18:44:48.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2022-09-26T13:39:10.000Z (over 2 years ago)
- Last Synced: 2023-03-10T03:32:26.424Z (about 2 years ago)
- Language: Vue
- Size: 150 KB
- Stars: 24
- Watchers: 2
- Forks: 7
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-ory - Ory Kratos Vue 3/Vite with Typescript example
- awesome-ory - Ory Kratos Vue 3/Vite with Typescript example
README
*Note from the original author: If you experience trouble using this project and are eager for rapid feedback, please [join the Ory Slack Channel](https://www.ory.sh/docs/guides/social-signin/slack) and reach out to me there. My username is Timothy Farrow.*
# Ory Kratos Vue3 / Vite with Typescript User Interface Reference Implementation
This repository contains a reference implementation for Ory Kratos' in Vue3 /
Vite with Typescript. It implements all Ory Kratos flows (login, registration, account
settings, account recovery, account verification).
If you only want to add authentication to your app, and not customize the login,
registration, account recovery, ... screens, please check out the
[Ory Kratos Quickstart](https://www.ory.sh/kratos/docs/quickstart).
Below you will find the default README for a Vue3 application.
## Recommended IDE Setup
[VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=johnsoncodehk.volar) (and disable Vetur) + [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=johnsoncodehk.vscode-typescript-vue-plugin).
## Type Support for `.vue` Imports in TS
TypeScript cannot handle type information for `.vue` imports by default, so we replace the `tsc` CLI with `vue-tsc` for type checking. In editors, we need [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=johnsoncodehk.vscode-typescript-vue-plugin) to make the TypeScript language service aware of `.vue` types.
If the standalone TypeScript plugin doesn't feel fast enough to you, Volar has also implemented a [Take Over Mode](https://github.com/johnsoncodehk/volar/discussions/471#discussioncomment-1361669) that is more performant. You can enable it by the following steps:
1. Disable the built-in TypeScript Extension
1) Run `Extensions: Show Built-in Extensions` from VSCode's command palette
2) Find `TypeScript and JavaScript Language Features`, right click and select `Disable (Workspace)`
2. Reload the VSCode window by running `Developer: Reload Window` from the command palette.
## Customize configuration
See [Vite Configuration Reference](https://vitejs.dev/config/).
## Project Setup
```sh
npm install
```
### Compile and Hot-Reload for Development
```sh
npm run dev
```
### Type-Check, Compile and Minify for Production
```sh
npm run build
```
### Run Unit Tests with [Vitest](https://vitest.dev/)
```sh
npm run test:unit
```
### Run End-to-End Tests with [Cypress](https://www.cypress.io/)
```sh
npm run build
npm run test:e2e # or `npm run test:e2e:ci` for headless testing
```
### Lint with [ESLint](https://eslint.org/)
```sh
npm run lint
```