Skip to content
k17nPublic

About

SoloKit: free, local-first, offline tools for freelancers and solopreneurs (India GST invoices, quotations, contracts). Source-available under PolyForm Strict.

Resources

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

SoloKit

Free, local-first tools for freelancers, consultants and solopreneurs. Everything runs in the browser, works offline, and keeps your data on your device. The only thing measured is visits, counted with Cloudflare Web Analytics: no cookies, no IP address stored, nothing you type, and skipped when Do Not Track or Global Privacy Control is on (see Analytics and hosting below). The service worker precaches the whole site at build time so it is fully usable offline. India (GST) comes first; other countries are coming soon.

Status

  • Done: monorepo, core primitives, India GST/TDS engine, design system, app shell, tool registry, local storage layer, installable offline site.
  • Done: invoice editor with live PDF preview, issuing, PDF download, and the invoice list (kind badge and filter, duplicate, cancel).
  • Done: invoice themes (six presets, your own colours and font, default and per-invoice choice) and the backup and restore screens (unencrypted JSON file, reminder after 30 days, restore on a fresh device).
  • Done: quotations and proforma invoices inside the invoice tool, each with its own number series (tax invoices keep theirs), a validity date on quotations, and Convert to invoice. A quotation is an estimate, not a tax invoice, and carries no tax-invoice wording.
  • Done: contract and NDA generator at /tools/contract/. Mutual and one-way NDAs and a freelance services agreement, a numbered editor (parties, key terms, optional clauses, jurisdiction and stamp duty note, review), PDF, editable Word and a Review pack for a lawyer, final/reopen, backups that carry agreements. Your details come from the shared business profile (entered once in the business setup) and saved clients. A template, not legal advice.
  • Done: Business workspaces at /business/. Each Business is a separate local database (the existing data became the first one); the site header has a switcher, and Your business holds the details every tool shares (name, address, tax ids, logo, payments, defaults), brand colours suggested from the logo with a one-click brand theme, backup and restore per Business (restore as a new Business is the default when the device has data), and rename, archive and delete (delete erases a Business from this device only, after typing its name). See docs/superpowers/plans/2026-10-17-workspaces.md.
  • Done: one business setup before any tool, at /app/setup/. Five steps (tax registration, business details, logo and brand colours, payment details, invoice defaults) ask once for everything every tool needs; a tool opened before setup sends people there and setup brings them back. Tools have no profile form of their own: their Business details link, and the Change links on Your business, open the same steps for editing and return to where they came from.
  • Done: "Get started" (home page and header) opens the app home at /app/: a new visitor goes through setup first and comes back to a welcome.
  • Done: the website and the app are separate. / is the website (hero, tools, how it works, a header with Tools, How it works, Privacy and Get started). /app/ is a SaaS-style app: a sidebar with the business switcher, search (Ctrl/⌘+K), Home, the tools, Your business and the tools coming soon (a drawer behind Menu on a phone), and pages that move without reloading (leaving unsaved work asks first). The app home greets the business and has a search for tools and actions ("/" focuses it, Enter opens the best match), quick actions that start a document, the latest documents and the tools. Tools open at a screen from a link: ?new=<kind> starts a document, ?doc=<id> opens one. The tools run at /app/invoice/ and /app/contract/; /tools// are their public landing pages. Old /setup/ and /business/ addresses forward into the app, and an installed SoloKit opens on /app/.
  • Next: more tools and countries.

Analytics and hosting

The site is a static export (apps/web/out) meant for Cloudflare Pages; step by step in docs/deploy-cloudflare-pages.md. Visits are counted with Cloudflare Web Analytics, loaded by apps/web/src/analytics/ only in a production build where NEXT_PUBLIC_CF_ANALYTICS_TOKEN is set, and never when the browser sends Do Not Track or Global Privacy Control. Dev, tests and forks send nothing by default. It counts page, referrer, country and device type; it never reads anything on a tool screen. Set NEXT_PUBLIC_SITE_URL at build time for the sitemap and absolute links (default is a placeholder).

Licence

SoloKit is source-available, not open source. The code is public so you can read it, learn from it and try it, under the PolyForm Strict License 1.0.0.

  • Allowed: read the code, and run it for noncommercial purposes (personal use, study, hobby projects, charities, schools, public bodies).
  • Not allowed: distributing it, changing it or building new works from it, or using it commercially, without written permission from the copyright holder.
  • The names SoloKit and its logo are not licensed. Do not use them for other products or services.
  • Bundled fonts and third-party libraries keep their own licences (see apps/web/public/fonts/invoice/THIRD_PARTY_LICENSES.txt).

This is not legal advice. To ask for permission, such as a commercial licence, open an issue or contact the owner.

See CONTRIBUTING.md before sending a pull request.

Layout

  • apps/web the website (Next.js, static export, installable PWA). app/(site)/ holds the static site (home, privacy, tool landing pages) and app/app/ the app under /app/ with its shell (src/app-shell/); src/paths.ts says where things live, and src/setup/ is the business setup every tool sends people to
  • packages/core country-agnostic primitives (integer-paise money, amount in words, invoice numbering)
  • packages/tax-engines TaxEngine interface, country list, India GST engine
  • packages/ui design tokens and shared components (header, footer, buttons, form fields, radio cards, notices)
  • packages/registry the list of tools; drives the home page, tool routes and footer
  • packages/storage DataStore interface with IndexedDB and in-memory adapters, and the Business (workspace) registry
  • packages/platform the open-core contract: feature list, entitlements, sync/sharing/messaging/payments/signing interfaces and UI slots, all with free no-op defaults (see docs/extension-points.md; paid features live in a separate private repo)
  • packages/profile the Business profile shared by all tools: model, validation, saved record, what each tool needs from it, and brand colour extraction from a logo
  • packages/tools/invoice the invoice tool's domain logic: data model, validation, document builder, themes, saved data, backup
  • packages/tools/invoice-pdf renders invoices to PDF in the browser (six layouts, bundled fonts, UPI QR); fonts are built with pnpm --filter @solokit/web fonts
  • packages/tools/contract the contract tool's domain logic: clause library as data, model, validation, document and review-pack builders, saved data, stamp-duty pointers
  • packages/tools/contract-export renders agreements to PDF, Review pack PDF and editable DOCX in the browser (reuses the invoice fonts and themes)
  • docs/legal-content-notes.md every legal assumption and default in the contract templates, for a lawyer's review
  • docs/extension-points.md the contract between this repo and a future private paid repo
  • docs/ideas.md backlog of tool ideas
  • docs/superpowers/specs design specs
  • docs/superpowers/plans implementation plans

Develop

npm install -g pnpm
pnpm install
pnpm dev          # http://localhost:3000
pnpm test
pnpm typecheck
pnpm build        # static site in apps/web/out
pnpm preview      # http://localhost:4173 (serves apps/web/out; try the offline mode here)
pnpm e2e          # builds, then runs the browser tests (uses the Chrome installed on your machine)

The service worker is stamped with the list of built files after next build and only registers in production builds, so test offline behaviour with pnpm build then pnpm preview.

Add a tool by creating its package under packages/tools/ and adding one entry to packages/registry/src/tools.ts.

Tax rates and thresholds are data (packages/tax-engines/src/in/rules.ts) with an "as of" date. They are not tax advice; verify with a chartered accountant.

About

SoloKit: free, local-first, offline tools for freelancers and solopreneurs (India GST invoices, quotations, contracts). Source-available under PolyForm Strict.

Resources

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages