Serendipity2-0 / TradeManV1

1 stars 0 forks source link

Documentation of FrontEnd KT from Anand #91

Closed VarshitaTP closed 2 months ago

VarshitaTP commented 2 months ago

Trademan.ai Project Documentation

Table of Contents

  1. Main Page
  2. Password and Dialogue Box
  3. User Dashboard
  4. Admin Dashboard
  5. Register Page

Main Page

The main page layout is defined in app/page.tsx. It consists of 6 components:

  1. Entire logo
  2. Star background
  3. Education
  4. SAS
  5. PMS
  6. Footer section

The code for these components is located in the components/Main folder.

Password and Dialogue Box

The code for the password and dialogue box is in main/loo.tsx.

User Dashboard

Profile

Portfolio View

Segments/Strategy

Note: Only user/client selected segments will be displayed in their respective user profiles. This is achieved in the sidebar.tsx file.

The entire user dashboard page setting is in user-profile/page.tsx.

Admin Dashboard

The admin dashboard page layout is defined in admin/page.tsx.

  1. Dashboard: Code in Dashboard/dashboard.tsx
  2. User Profile: Code in admin/userprofile.tsx
  3. Strategy:
    • Main file: admin/strategy.tsx
    • Components are defined in the user profile/startegy parameter folder
  4. Order Executor:
    • Trade state: tradestate.tsx
    • Place order (main component): orderexecutor.tsx
    • Complete order (Order mode): completeorder.tsx
    • Repair order (Order mode): repairorder.tsx
  5. Error Log: errorlog.tsx
  6. Signals:
    • Tabular data: signals/signals.tsx
    • Chart/graph: chart/chart.tsx

Register Page

The register page is defined in app/register/page.tsx (progress stepper is called here).

Components

  1. Progress Stepper (main component)
  2. Six form pages:
    • register.tsx
    • personalinfo.tsx
    • broker.tsx
    • riskprofile.tsx
    • margindistribution.tsx
    • strategy.tsx

Register Service

register.service.tsx contains register process endpoints provided by the backend to store data in the database/firebase.

VarshitaTP commented 2 months ago

Documented the Knowledge Transfer meeting related to trademan.ai frontend code base.