React + TypeScript + Vite

This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.

Getting Started

Prerequisites

• Node.js (v16 or higher)
• npm or yarn

Installation & Running the Project

1. Clone the repository and navigate to the project directory
2. Install dependencies:

   npm install

3. Start the development server:

   npm run dev

4. Open your browser and navigate to http://localhost:5173 (or the URL shown in your terminal)

Build for Production

To build the project for production:

npm run build

To preview the production build:

npm run preview

Design Reference

Please use the following Figma design for building out the frontend: Figma Design

Currently, two official plugins are available:

• @vitejs/plugin-react uses Babel (or oxc when used in rolldown-vite) for Fast Refresh
• @vitejs/plugin-react-swc uses SWC for Fast Refresh

React Compiler

The React Compiler is not enabled on this template because of its impact on dev & build performances. To add it, see this documentation.

Expanding the ESLint configuration

If you are developing a production application, we recommend updating the configuration to enable type-aware lint rules:

export default defineConfig([
  globalIgnores(['dist']),
  {
    files: ['**/*.{ts,tsx}'],
    extends: [
      // Other configs...

      // Remove tseslint.configs.recommended and replace with this
      tseslint.configs.recommendedTypeChecked,
      // Alternatively, use this for stricter rules
      tseslint.configs.strictTypeChecked,
      // Optionally, add this for stylistic rules
      tseslint.configs.stylisticTypeChecked,

      // Other configs...
    ],
    languageOptions: {
      parserOptions: {
        project: ['./tsconfig.node.json', './tsconfig.app.json'],
        tsconfigRootDir: import.meta.dirname,
      },
      // other options...
    },
  },
])

You can also install eslint-plugin-react-x and eslint-plugin-react-dom for React-specific lint rules:

// eslint.config.js
import reactX from 'eslint-plugin-react-x'
import reactDom from 'eslint-plugin-react-dom'

export default defineConfig([
  globalIgnores(['dist']),
  {
    files: ['**/*.{ts,tsx}'],
    extends: [
      // Other configs...
      // Enable lint rules for React
      reactX.configs['recommended-typescript'],
      // Enable lint rules for React DOM
      reactDom.configs.recommended,
    ],
    languageOptions: {
      parserOptions: {
        project: ['./tsconfig.node.json', './tsconfig.app.json'],
        tsconfigRootDir: import.meta.dirname,
      },
      // other options...
    },
  },
])

Environment Variables

The frontend requires the following environment variables:

Development (.env)

VITE_API_URL=http://localhost:3000/api VITE_WS_URL=http://localhost:3000

Production

VITE_API_URL=https://your-backend-domain.com/api VITE_WS_URL=https://your-backend-domain.com

⚠️ The backend must allow CORS for the frontend CLIENT_URL. Example: CLIENT_URL=https://your-frontend-domain.com

Education & Learn Page

The /learn page is now fully integrated with the backend API. Content can be updated dynamically without requiring a frontend redeployment.

Backend Endpoints

• GET /api/education/guides: Fetches the list of educational guides.
• GET /api/education/tip: Fetches the current "alpha" tip of the day.

Components

• LearnPage: Main container fetching and managing state for education content.
• GuideCard: Premium card component for displaying individual guides.
• TipCard: High-impact card component for the daily tip.
• StatusStates: Reusable Loading, Error, and Empty state components.

Testing

Unit tests are implemented using Vitest and React Testing Library. Run unit tests:

npm run test:unit