feat: new readme
This commit is contained in:
parent
b1814d6249
commit
061bcd8d1a
2 changed files with 4 additions and 39 deletions
1
.env.example
Normal file
1
.env.example
Normal file
|
|
@ -0,0 +1 @@
|
|||
PUBLIC_BACKEND_API_HOST=https://hexname.com
|
||||
42
README.md
42
README.md
|
|
@ -1,41 +1,5 @@
|
|||
# sv
|
||||
# HexName's Frontend
|
||||
|
||||
Everything you need to build a Svelte project, powered by
|
||||
[`sv`](https://github.com/sveltejs/cli).
|
||||
This is the frontend written in Sveltekit using Tailwind and DaisyUI used for the website/my project [HexName](https://hexname.com)
|
||||
|
||||
## Creating a project
|
||||
|
||||
If you're seeing this, you've probably already done this step. Congrats!
|
||||
|
||||
```sh
|
||||
# create a new project in the current directory
|
||||
npx sv create
|
||||
|
||||
# create a new project in my-app
|
||||
npx sv create my-app
|
||||
```
|
||||
|
||||
## Developing
|
||||
|
||||
Once you've created a project and installed dependencies with `npm install` (or
|
||||
`pnpm install` or `yarn`), start a development server:
|
||||
|
||||
```sh
|
||||
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:
|
||||
|
||||
```sh
|
||||
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://svelte.dev/docs/kit/adapters) for your target environment.
|
||||
For deployment, the static-adapter is used.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue