dvdrw
/
litechatplus
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

ci: update README

This commit is contained in:
dvdrw 2023-02-11 19:11:29 +01:00
parent 843d38ad4f
commit f415ffd6be
Signed by: dvdrw
GPG Key ID: 044B8425E3CD03E0
1 changed files with 9 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
README.md
View File

@ -1,38 +1,18 @@
# create-svelte
# litechatplus
Everything you need to build a Svelte project, powered by [`create-svelte`](https://github.com/sveltejs/kit/tree/master/packages/create-svelte).
A client for fedwave-compatbile chat servers. Basically litechat, but better.
## 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 create svelte@latest
# create a new project in my-app
npm create svelte@latest my-app
```
Early in development, assume everything is broken.
## 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
```
After `git pull`ing, do the standard `npm ci`. You can run a live-updating
development server with `npm run dev`.
## Building
To create a production version of your app:
To create a production build, run `npm run build`. You can quickly preview the
build with `npm run preview`.
```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.
It currently builds the app as a bunch of static files. Since it uses dynamic
routing (i.e. `/channelname`), there's a default redirect from `/` -> `/global`.