Skip to content

Commit 4bd2083

Browse files
committed
update readme
1 parent a657407 commit 4bd2083

File tree

3 files changed

+21
-36
lines changed

3 files changed

+21
-36
lines changed

README.md

Lines changed: 21 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,27 @@
1-
# sv
1+
# Flowchart builder
22

3-
Everything you need to build a Svelte project, powered by [`sv`](https://github.com/sveltejs/cli).
3+
This is hella simple Flowchart builder made with Svelte and XYflow
44

5-
## Creating a project
5+
### What you can do
6+
- Create multiple project
7+
- Copy, paste, duplicate node
8+
- Property editing
9+
- Export whole flowchart
10+
- Autosave
611

7-
If you're seeing this, you've probably already done this step. Congrats!
12+
### What you can't?
13+
- Undo/redo
14+
- Export in page form
815

9-
```sh
10-
# create a new project in the current directory
11-
npx sv create
16+
### Credit
17+
- [Svelte](https://svelte.dev) - Frontend framework
18+
- [xyflow](https://svelteflow.dev) - Node UI builder
19+
- [Tailwind](https://tailwindcss.com) & [daisyui](https://daisyui.com) - styling
20+
- [Dexie](https://dexie.org) - Manging Indexxed DB
21+
- [lz-string](https://pieroxy.net/blog/pages/lz-string/index.html) - String compression
22+
- [nanoid](https://github.com/ai/nanoid) - ID Generator
23+
- [date-fns](https://date-fns.org/) - Date formatting
1224

13-
# create a new project in my-app
14-
npx sv create my-app
15-
```
25+
> [!NOTE]
26+
> BTW, Currently i open for a job, can't wait to build something like this with you in bigger scale
1627
17-
## Developing
18-
19-
Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:
20-
21-
```sh
22-
npm run dev
23-
24-
# or start the server and open the app in a new browser tab
25-
npm run dev -- --open
26-
```
27-
28-
## Building
29-
30-
To create a production version of your app:
31-
32-
```sh
33-
npm run build
34-
```
35-
36-
You can preview the production build with `npm run preview`.
37-
38-
> To deploy your app, you may need to install an [adapter](https://svelte.dev/docs/kit/adapters) for your target environment.

package.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@
1212
"check:watch": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json --watch"
1313
},
1414
"devDependencies": {
15-
"@svelte-put/shortcut": "^4.1.0",
1615
"@sveltejs/adapter-auto": "^6.0.0",
1716
"@sveltejs/adapter-static": "^3.0.9",
1817
"@sveltejs/kit": "^2.22.0",

pnpm-lock.yaml

Lines changed: 0 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)