84 lines
3.7 KiB
Markdown
84 lines
3.7 KiB
Markdown
# `ts_web/` Web App Module
|
|
|
|
The `ts_web/` folder contains the frontend for `idp.global`: login, registration, account management, org management, billing, and admin UI.
|
|
|
|
It is built with `@design.estate/dees-element`, `@design.estate/dees-domtools`, and the shared `idp.global` client and interface packages.
|
|
|
|
## Issue Reporting and Security
|
|
|
|
For reporting bugs, issues, or security vulnerabilities, please visit [community.foss.global/](https://community.foss.global/). This is the central community hub for all issue reporting. Developers who sign and comply with our contribution agreement and go through identification can also get a [code.foss.global/](https://code.foss.global/) account to submit Pull Requests directly.
|
|
|
|
## What Lives Here
|
|
|
|
| Path | Purpose |
|
|
| --- | --- |
|
|
| `index.ts` | Frontend entrypoint and initial render |
|
|
| `views/viewcontainer.ts` | View switching for welcome, login, register, finishregistration, and account |
|
|
| `elements/` | Web components for prompts, layout, and account UI |
|
|
| `elements/account/views/` | Account subviews including org, apps, subscriptions, paddle setup, and admin |
|
|
| `states/` | App-level and account-level state containers |
|
|
|
|
## UI Surface
|
|
|
|
The module currently includes:
|
|
|
|
- a welcome page
|
|
- login and registration prompts
|
|
- a multi-step registration flow
|
|
- an account area with navigation
|
|
- organization selection and creation flows
|
|
- bulk member invitation UI
|
|
- app and subscription views
|
|
- a global admin view
|
|
|
|
## Routing
|
|
|
|
`IdpViewcontainer` switches between these frontend states:
|
|
|
|
| View | Route |
|
|
| --- | --- |
|
|
| `welcome` | `/` |
|
|
| `login` | `/login` |
|
|
| `register` | `/register` |
|
|
| `finishregistration` | `/finishregistration` |
|
|
| `account` | `/account` |
|
|
|
|
## Build And Run
|
|
|
|
From the repository root:
|
|
|
|
```bash
|
|
pnpm install
|
|
pnpm build
|
|
pnpm watch
|
|
```
|
|
|
|
`pnpm watch` rebuilds the frontend bundle from `ts_web/index.ts` into `dist_serve/bundle.js` while the backend serves the app.
|
|
|
|
## Notes
|
|
|
|
- The app metadata in `ts_web/index.ts` identifies the site as `idp.global`.
|
|
- The frontend uses the shared client package for auth state and backend communication.
|
|
- Account-related UI is split into reusable elements plus state containers in `states/`.
|
|
|
|
## License and Legal Information
|
|
|
|
This repository contains open-source code licensed under the MIT License. A copy of the license can be found in the [license](../license) file.
|
|
|
|
**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.
|
|
|
|
### Trademarks
|
|
|
|
This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH or third parties, and are not included within the scope of the MIT license granted herein.
|
|
|
|
Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines or the guidelines of the respective third-party owners, and any usage must be approved in writing. Third-party trademarks used herein are the property of their respective owners and used only in a descriptive manner, e.g. for an implementation of an API or similar.
|
|
|
|
### Company Information
|
|
|
|
Task Venture Capital GmbH
|
|
Registered at District Court Bremen HRB 35230 HB, Germany
|
|
|
|
For any legal inquiries or further information, please contact us via email at hello@task.vc.
|
|
|
|
By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.
|