write readme
This commit is contained in:
parent
f2d535b68b
commit
58f67b747c
48
README.md
48
README.md
|
@ -1,38 +1,14 @@
|
||||||
# create-svelte
|
# ava
|
||||||
|
|
||||||
Everything you need to build a Svelte project, powered by [`create-svelte`](https://github.com/sveltejs/kit/tree/main/packages/create-svelte).
|
ava is a simple avatar server written in TypeScript with SvelteKit and OIDC support.
|
||||||
|
This exists for a few reasons:
|
||||||
|
1. I wanted to learn SvelteKit
|
||||||
|
2. I wanted to try implementing OAuth2/OIDC
|
||||||
|
3. Authentik doesn't have built-in handling for profile pictures
|
||||||
|
- ...and I don't wish to use hacky shit with attributes...
|
||||||
|
- ...I hate Gravatar...
|
||||||
|
- ...and in my opinion, Libravatar/ivatar is fucking ugly
|
||||||
|
|
||||||
## Creating a project
|
<p align="center">
|
||||||
|
<img alt="Screenshot of the ava homepage" src=readme/screenshot.png>
|
||||||
If you're seeing this, you've probably already done this step. Congrats!
|
</p>
|
||||||
|
|
||||||
```bash
|
|
||||||
# create a new project in the current directory
|
|
||||||
npm create svelte@latest
|
|
||||||
|
|
||||||
# create a new project in my-app
|
|
||||||
npm create svelte@latest my-app
|
|
||||||
```
|
|
||||||
|
|
||||||
## 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
|
|
||||||
```
|
|
||||||
|
|
||||||
You can preview the production build with `npm run preview`.
|
|
||||||
|
|
||||||
> To deploy your app, you may need to install an [adapter](https://kit.svelte.dev/docs/adapters) for your target environment.
|
|
BIN
readme/screenshot.png
Normal file
BIN
readme/screenshot.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 61 KiB |
Loading…
Reference in a new issue