Skip to content

docs: Restore dep-charge README #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
yousecjoe wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: Restore dep-charge README #13

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 37 additions & 18 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,42 +1,61 @@
# sv
# dep-charge

Everything you need to build a Svelte project, powered by [`sv`](https://github.com/sveltejs/cli).
A tool that analyzes all the dependencies in a project and gives a rating from 1 to 10 on how likely it is to get breached.

## Creating a project
Built with SvelteKit + Bun, powered by Claude for ecosystem-agnostic dependency analysis. Submit a lock or manifest file via upload, paste, Git URL, or local path, and dep-charge streams back a breach-likelihood score, a per-dependency breakdown, and remediation recommendations.

If you're seeing this, you've probably already done this step. Congrats!
## Tech stack

- **Runtime:** [Bun](https://bun.sh)
- **Framework:** SvelteKit 2 + Svelte 5 (runes mode)
- **Language:** TypeScript
- **AI:** Anthropic Claude via `@anthropic-ai/sdk`

## Getting started

Copy the example environment file and set your Anthropic API key:

```sh
# create a new project
npx sv create my-app
cp env.example .env.local
# then edit .env.local and set ANTHROPIC_API_KEY
```

To recreate this project with the same configuration:
Optionally set `CLAUDE_MODEL` to override the default model.

Install dependencies:

```sh
# recreate this project
npx sv@0.14.0 create --template minimal --types ts --no-install .
bun install
```

## Developing

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

```sh
npm run dev

# or start the server and open the app in a new browser tab
npm run dev -- --open
bun run dev
```

## Building

To create a production version of your app:
Create a production build:

```sh
bun run build
```

Preview the production build:

```sh
bun run preview
```

Run TypeScript type checking:

```sh
npm run build
bun run check
```

You can preview the production build with `npm run preview`.
## License

> To deploy your app, you may need to install an [adapter](https://svelte.dev/docs/kit/adapters) for your target environment.
MIT — owned by Young Security.