diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..75bc2d0 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2026 StepFi + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md index 65a8119..13858b1 100644 --- a/README.md +++ b/README.md @@ -58,6 +58,12 @@ From the web app, a mentor can: ## How this fits into the StepFi ecosystem +
+ +StepFi system architecture β€” StepFi-Web highlighted + +
+ StepFi is split across multiple repositories that together form one protocol: | Repo | Purpose | Stack | @@ -139,6 +145,37 @@ No local backend setup is required to start contributing to the frontend. --- +## Scripts + +| Command | What it does | +|---------|--------------| +| `npm run dev` | Start the Vite dev server | +| `npm run build` | Type-check (`tsc -b`) and produce a production build | +| `npm run preview` | Preview the production build locally | +| `npm run lint` | Lint with ESLint | +| `npm test` | Run the Vitest suite once | +| `npm run test:coverage` | Run tests with a coverage report | +| `npm run test:a11y` | Build, then run the accessibility checks (`test-a11y.mjs`) | + +## πŸ”„ CI/CD + +Every push and PR runs [`.github/workflows/ci.yml`](.github/workflows/ci.yml) β€” a **required check on `main`** β€” covering lint, type-check, unit tests, and the production build. The app deploys to Netlify ([`netlify.toml`](netlify.toml)); the landing page is served from Vercel ([`vercel.json`](vercel.json)). + +## πŸ›£οΈ Roadmap + +| Milestone | Status | +|-----------|--------| +| Sponsor pool dashboard β€” deposits, shares, live pool stats | βœ… | +| Vendor registration, catalog, and payment history | βœ… | +| Mentor vouching β€” review, submit, track, revoke | βœ… | +| Wallet connect (Freighter) + TanStack Query data layer | βœ… | +| Enforced CI gate (lint Β· type-check Β· test Β· build) | βœ… | +| Accessibility test pass (`test:a11y`) | βœ… | +| Live wallet-signature JWT auth (shared with StepFi-App) | 🚧 | +| Editable sponsor/vendor profiles Β· notification preferences | πŸ—ΊοΈ | + +--- + ## Contributing StepFi-Web is open source and welcomes contributors of all experience levels. @@ -179,4 +216,4 @@ https://contribute.grantfox.xyz/org/StepFi-app ## License -MIT +Released under the [MIT License](./LICENSE). diff --git a/public/architecture.svg b/public/architecture.svg new file mode 100644 index 0000000..fd96169 --- /dev/null +++ b/public/architecture.svg @@ -0,0 +1,115 @@ + + + + + + + + + + + + + StepFi β€” System Architecture + Reputation-based micro-credit for students & small vendors, settled on Stellar + + + + + + πŸ“š StepFi-Docs + Protocol documentation + + + USERS + + + + + + πŸŽ“ Learners + πŸ’š Sponsors + πŸͺ Vendors + + + CLIENTS + + + + + πŸ“± StepFi-App + Expo Β· React Native + learner & sponsor mobile client + 🌐 StepFi-Web + marketing site & + web dashboard + + + WALLETS + + + + πŸ” Wallets + Freighter (web) Β· Lobstr (mobile) + via WalletConnect Β· sign XDR / message + + + BACKEND + + + + βš™οΈ StepFi-API + NestJS backend Β· REST + + + πŸ”‘ Auth Β· JWT + + πŸ”— Orchestration + + ⏱ Jobs + + + + + + + + + + sign + REST Β· JWT + + + + + + ✦ Stellar Network β€” Soroban platform (testnet) Β· StepFi-Contracts + + + + + + + Creditline + Reputation + Liquidity Pool + Vendor Registry + Parameters + + + loans & repayment + score & tiers + sponsor funds + verified merchants + governance Β· multisig + + + + + + + + Soroban RPC + submit signed XDR + this repo +