update readme
This commit is contained in:
parent
e04e6db22a
commit
073bf65094
0
.idea/vpgen-sv5.iml → .idea/vpgen.iml
generated
0
.idea/vpgen-sv5.iml → .idea/vpgen.iml
generated
54
README.md
54
README.md
@ -1,40 +1,26 @@
|
||||
# sv
|
||||
# VPGen
|
||||
|
||||
Everything you need to build a Svelte project, powered by [`sv`](https://github.com/sveltejs/cli).
|
||||
One-click WireGuard config generator, work in progress.
|
||||
|
||||
## Creating a project
|
||||
## Why?
|
||||
|
||||
If you're seeing this, you've probably already done this step. Congrats!
|
||||
Make it easier to share VPN access with friends/family,
|
||||
making use of (my) existing networking infrastructure.
|
||||
|
||||
```bash
|
||||
# create a new project in the current directory
|
||||
npx sv create
|
||||
## How?
|
||||
|
||||
# create a new project in my-app
|
||||
npx sv create my-app
|
||||
Currently, the supported backend is [OPNsense](https://opnsense.org/).
|
||||
VPGen just creates WireGuard clients on the configured interface via the OPNsense API.
|
||||
|
||||
Future plans include supporting other API backends, e.g. [Netmaker](https://github.com/gravitl/netmaker)
|
||||
|
||||
## Development
|
||||
|
||||
Development uses bun.
|
||||
|
||||
For example .env settings, see [.env.example](.env.example)
|
||||
|
||||
```shell
|
||||
bun install
|
||||
bun run dev
|
||||
```
|
||||
|
||||
## 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://svelte.dev/docs/kit/adapters) for your target environment.
|
||||
|
||||
When deploying, set `ORIGIN` to the URL of your site to prevent cross-site request errors.
|
||||
|
2
bun.lock
2
bun.lock
@ -2,7 +2,7 @@
|
||||
"lockfileVersion": 1,
|
||||
"workspaces": {
|
||||
"": {
|
||||
"name": "vpgen-sv5",
|
||||
"name": "vpgen",
|
||||
"dependencies": {
|
||||
"@libsql/client": "^0.14.0",
|
||||
"drizzle-kit": "^0.30.4",
|
||||
|
@ -1,5 +1,5 @@
|
||||
{
|
||||
"name": "vpgen-sv5",
|
||||
"name": "vpgen",
|
||||
"version": "0.0.1",
|
||||
"type": "module",
|
||||
"scripts": {
|
||||
|
Loading…
x
Reference in New Issue
Block a user