Northstar

https://github.com/zangster300/northstar
Admin
Northstar is a Go-based web application utilizing NATS, Datastar, and Templ for real-time...
Tokens:2,185
Snippets:12
Trust Score:5
License:MIT
Update:1 year ago
Show doc for...
Tokens:
Raw
### Install Dependencies

Source: https://github.com/zangster300/northstar/blob/main/internal/ui/libs/lit/README.md

Installs the necessary project dependencies using pnpm.

```shell
pnpm install
```

--------------------------------

### Vite Configuration Example

Source: https://github.com/zangster300/northstar/blob/main/internal/ui/libs/lit/README.md

Example Vite configuration showing a plugin for copying bundled files to the static directory.

```typescript
import { defineConfig } from 'vite'
import { viteStaticCopy } from 'vite-plugin-static-copy'

export default defineConfig({
  plugins: [
    viteStaticCopy({
      targets: [
        {
          src: 'dist/**/*',
          dest: '../../static/'
        }
      ]
    })
  ],
  build: {
    lib: {
      entry: 'src/index.ts',
      name: 'MyLib',
      fileName: (format) => `my-lib.${format}.js`
    }
  }
})
```

--------------------------------

### Install Go Dependencies

Source: https://github.com/zangster300/northstar/blob/main/README.md

Installs project dependencies using Go modules.

```go
go mod tidy
```

--------------------------------

### Build and Bundle Project

Source: https://github.com/zangster300/northstar/blob/main/internal/ui/libs/lit/README.md

Builds and bundles the project, copying the output to the static directory via a Vite plugin.

```shell
pnpm build
```

--------------------------------

### Start Development Server with Live Reload

Source: https://github.com/zangster300/northstar/blob/main/README.md

Starts the development server with live reload enabled using Air and Templ.

```shell
go tool task live
```

--------------------------------

### Run Northstar Server

Source: https://github.com/zangster300/northstar/blob/main/README.md

Starts the Northstar application server.

```shell
go tool task run
```

--------------------------------

### Development Build

Source: https://github.com/zangster300/northstar/blob/main/internal/ui/libs/lit/README.md

Builds the project in development mode.

```shell
pnpm build:dev
```

--------------------------------

### NATS Key-Value Store Operations

Source: https://github.com/zangster300/northstar/blob/main/README.md

Demonstrates common operations for interacting with NATS Key-Value buckets, including listing buckets, listing keys, getting values, and putting values.

```shell
# list key value buckets
nats kv ls

# list keys in the `todos` bucket
nats kv ls todos

# get the value for [key]
nats kv get --raw todos [key]

# put a value into [key]
nats kv put todos [key] '{"todos":[{"text":"Hello, NATS!","completed":true}],"editingIdx":-1,"mode":0}'
```

--------------------------------

### Build Northstar Executable

Source: https://github.com/zangster300/northstar/blob/main/README.md

Builds an executable binary for the Northstar project with static assets embedded.

```shell
go tool task build
```

--------------------------------

### Docker Build and Run

Source: https://github.com/zangster300/northstar/blob/main/README.md

Builds a Docker image for Northstar and runs it as a container.

```docker
# build an image
docker build -t northstar:latest .

# run the image in a container
docker run --name northstar -p 8080:9001 northstar:latest
```

--------------------------------

### Debug Northstar Project

Source: https://github.com/zangster300/northstar/blob/main/README.md

Launches the project with the Delve debugger for a debugging session.

```shell
go tool task debug
```

--------------------------------

### Clone Northstar Repository

Source: https://github.com/zangster300/northstar/blob/main/README.md

Clones the Northstar project repository from GitHub.

```shell
git clone https://github.com/zangster300/northstar.git
```
Tokens:
Raw