ikanban-web 0.2.6 → 0.2.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,34 +1,39 @@
1
- ## Usage
1
+ # ikanban
2
2
 
3
- Dependencies for these templates are managed with [pnpm](https://pnpm.io) using `pnpm up -Lri`.
3
+ iKanban is a Web interface for the [OpenCode](https://opencode.ai) AI coding agent. It unifies chat, terminal, and board workflows in a single interface so teams can plan, execute, and track coding tasks.
4
4
 
5
- This is the reason you see a `pnpm-lock.yaml`. That said, any package manager will work. This file can safely be removed once you clone a template.
5
+ ## UI Previews
6
6
 
7
- ```bash
8
- $ npm install # or pnpm install or yarn install
9
- ```
7
+ <details>
8
+ <summary>Expand screenshots</summary>
10
9
 
11
- ### Learn more on the [Solid Website](https://solidjs.com) and come chat with us on our [Discord](https://discord.com/invite/solidjs)
10
+ <img width="3695" height="2149" alt="Image" src="https://github.com/user-attachments/assets/b5ca21b8-b8aa-46f6-84cc-8906f629b6c8" />
12
11
 
13
- ## Available Scripts
12
+ </details>
14
13
 
15
- In the project directory, you can run:
14
+ ## Quick Start
16
15
 
17
- ### `npm run dev` or `npm start`
16
+ ### Option 1: Use the hosted app (recommended)
18
17
 
19
- Runs the app in the development mode.<br>
20
- Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
18
+ Open: https://isomoes.github.io/ikanban
21
19
 
22
- The page will reload if you make edits.<br>
20
+ Start OpenCode with CORS enabled for GitHub Pages:
23
21
 
24
- ### `npm run build`
22
+ ```bash
23
+ opencode serve --port <PORT> --cors https://isomoes.github.io
24
+ ```
25
25
 
26
- Builds the app for production to the `dist` folder.<br>
27
- It correctly bundles Solid in production mode and optimizes the build for the best performance.
26
+ Then add your server URL in settings: `http://localhost:<PORT>`.
28
27
 
29
- The build is minified and the filenames include the hashes.<br>
30
- Your app is ready to be deployed!
28
+ ### Option 2: Run locally with npx
29
+
30
+ ```bash
31
+ npx ikanban-web@latest # Start on port 3000
32
+ npx ikanban-web@latest --port 8080 # Custom port
33
+ OPENCODE_URL=http://myserver:4096 npx ikanban-web@latest # External OpenCode server
34
+ ```
31
35
 
32
- ## Deployment
36
+ ## Acknowledgments
33
37
 
34
- You can deploy the `dist` folder to any static host provider (netlify, surge, now, etc.)
38
+ - Inspired by and thanks to the [openchamber](https://github.com/btriapitsyn/openchamber) project.
39
+ - [opencode web UI](https://github.com/anomalyco/opencode/tree/dev/packages/app)