Files
Ten31-Portal/deploy/instructions.md
Jonathan Kirkwood f0f8fd15c6 Release 0.2.22: capital chart, Investor View, GP stakes, doc folders
Snapshot commit bringing the uncommitted phase-2 work into version control
together with four new features and the 0.2.22 version bump.

New features:
- Investor capital-over-time chart (value, paid-in, distributions per
  quarter), rendered from existing capital-account history.
- Admin Investor View: read-only reconstruction of an investor's portal
  (GET /api/users/{id}/investor-view), reusing the investor portal UI.
- Document upload scoped to the selected fund's own investors, with an
  explicit upload-target confirmation to prevent mis-attaching.
- GP/mgmt entities gain an Assets tab listing their stakes in the funds
  they manage (new entity_stakes table + /api/entities/{id}/stakes).
- Edit-entity form (change type/status/etc.), so GP entities can be
  categorized correctly.

Verified: 11/11 backend tests pass; alembic upgrades to head b8c9d0e1f2a3;
frontend tsc + vite build clean; s9pk packs at 0.2.22:0 (x86_64).
Also: ignore .DS_Store and *.s9pk artifacts.
2026-07-01 14:25:50 -05:00

40 lines
1.7 KiB
Markdown

# Ten31Portal
Internal system of record for Ten31 entities, holdings, positions, and quarterly
valuation sign-off, plus an investor / fund-administrator portal.
## First login
On first boot a default administrator (approver) account is created. Unless you set
the environment variables below, the defaults are:
- **Username:** `admin`
- **Password:** `Ten31`
Open the web interface and sign in. Change this password immediately from the Users
screen, or create a new admin and disable the default one.
The login field accepts a username **or** an email address.
## Accounts and access
- **Internal staff** (`approver`, `cfo`, `fund_admin`, `viewer`) use the back-office
app: entities, holdings, positions, valuation rounds, import, and audit log.
Approvers and the CFO also get the admin screens below.
- **External accounts** (`investor`, `fund_administrator`) get an entity-scoped
portal and only ever see the entities granted to them.
- **Investors** see, per fund, their latest capital-account value and history, plus
documents shared to the fund or addressed privately to them (e.g. their K-1).
- **Fund administrators** see their assigned entities and can upload documents.
From the **Users** screen, create an account with a username and password and check
off which entities it can view. Use **Documents** to upload statements and K-1s
(shared to a fund or private to one investor), and **Capital Accounts** to enter each
investor's figures.
## Data and backups
All data — the database, uploaded documents, and the generated session secret — lives
on the service's data volume and is included in StartOS platform backups. Create a
backup before uninstalling; uninstalling removes all fund data.