Update README
This commit is contained in:
parent
92d4f00d30
commit
5dcad7fa38
1 changed files with 20 additions and 26 deletions
46
README.md
46
README.md
|
@ -1,38 +1,32 @@
|
||||||
# create-svelte
|
# Shadow
|
||||||
|
A blogging platform for Shadow Hosting.
|
||||||
|
|
||||||
Everything you need to build a Svelte project, powered by [`create-svelte`](https://github.com/sveltejs/kit/tree/main/packages/create-svelte).
|
## Development
|
||||||
|
|
||||||
## Creating a project
|
Requirements:
|
||||||
|
- NodeJS + Bun (issue with some dev things)
|
||||||
|
- Golang 1.22
|
||||||
|
|
||||||
If you're seeing this, you've probably already done this step. Congrats!
|
Install the JS dependencies with `bun install`, and go dependencies with `go get`
|
||||||
|
|
||||||
```bash
|
Create a config file and set `dev` to be true:
|
||||||
# create a new project in the current directory
|
```toml
|
||||||
npm create svelte@latest
|
version = 1
|
||||||
|
|
||||||
# create a new project in my-app
|
dev = true
|
||||||
npm create svelte@latest my-app
|
app_url = "http://192.168.1.40:3030"
|
||||||
|
|
||||||
|
[server]
|
||||||
|
host = "0.0.0.0"
|
||||||
|
port = 3030
|
||||||
|
cloudflare_proxy = false
|
||||||
```
|
```
|
||||||
|
|
||||||
## Developing
|
To start the development server (vite will run with it):
|
||||||
|
|
||||||
Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npm run dev
|
go run *.go run
|
||||||
|
|
||||||
# or start the server and open the app in a new browser tab
|
|
||||||
npm run dev -- --open
|
|
||||||
```
|
```
|
||||||
|
|
||||||
## Building
|
## Building
|
||||||
|
|
||||||
To create a production version of your app:
|
No info at this time
|
||||||
|
|
||||||
```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.
|
|
Loading…
Reference in a new issue