Skip to content

Commit

Permalink
simplify the frontend's README (#3)
Browse files Browse the repository at this point in the history
Signed-off-by: BrickPi <49528459+BrickPi@users.noreply.github.com>
  • Loading branch information
BrickPi authored May 9, 2023
1 parent 867addc commit 887084a
Showing 1 changed file with 6 additions and 26 deletions.
32 changes: 6 additions & 26 deletions frontend/README.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,18 @@
# create-svelte

Everything you need to build a Svelte project, powered by [`create-svelte`](https://github.com/sveltejs/kit/tree/master/packages/create-svelte).

## 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
```
# The OpenVic2 Website Frontend
The frontend is pretty simple, using [sveltekit](https://kit.svelte.dev) for the UI and routing. If you see something and think it could be a good change, feel free to either suggest it in #issues, the discord, or to simply fork the repo, make the change, and open a PR.

## Developing

Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:

All you need installed is NPM and a recent verion of NodeJS (LTS preffered)
To see the project, inside the `/frontend` folder run
```bash
npm i
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:

To build a production version in `/frontend/dist` run
```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.

0 comments on commit 887084a

Please sign in to comment.