Skip to main content

Project Structure

This project is organized into a backend API (solid-api) and frontend UI (solid-ui) along with supporting scripts and configurations.

.
├── .vscode/                  # VS Code settings
├── solid-api/                # Backend API (NestJS)
├── solid-ui/                 # Frontend UI (Next.js)
└── upgrade.sh                # SolidX upgrade script

solid-api/ - Backend (NestJS & TypeORM)​

This folder contains all backend services, business logic, and configurations.

solid-api/
├── .env, .gitignore, etc.       # Config and ignore files
├── logs/                        # Application / Error logs
├── media-files-storage/         # Uploaded or generated files
├── media-uploads/               # Temporary upload folder
├── module-metadata/             # Module metadata (JSON)
├── src/                         # Source code for the backend
├── test/                        # E2E tests
├── rebuild*.sh / refresh.bat    # Rebuild and refresh scripts

Notable Subfolders​

  • src/
    • Contains main.ts (entry point for the SolidX backend) and all SolidX modules like:
      • fees-portal/
    • main-cli.ts -> entry point for the SolidX cli commands.
    • app.module.ts -> Contains the application module configuration.
    • app-default-database.module.ts -> Contains all the database configuration.

SolidX dependencies​

  • @solidxai/core
    • Contains the core SolidX module which provides the core backend services for SolidX.
  • @solidstarters/solid-code-builder
    • Contains the functionality for generating the code in the SolidX backend.

SolidX modules​

  • A SolidX module is a logical container that groups together related models and functionality under a unified domain or feature area e.g fees-portal.
  • You can find the structure for a SolidX module here Generated Code.

solid-ui/ - Frontend (Next.js & Prime React)​

The frontend is built using Next.js and Prime React components.

solid-ui/
├── .env, .gitignore       # Config / ignore files
├── .next/                 # Next.js build output
├── app/                   # App Router pages (e.g., admin, auth)
├── public/                # Static assets like icons and SVGs
├── redux/                 # Global Redux store config
├── types/                 # TypeScript type declarations
├── next.config.js         # Next.js configuration
├── middleware.ts          # App-wide config and middlewares

Notable Subfolders​

  • app/
    • Entry point for routes like /admin, /auth, etc.
    • layout and providers via layout.tsx and GlobalProvider.tsx.
  • public/
    • Contains static files and theme assets.
  • redux/
    • Global state configuration.

SolidX dependencies​

  • @solidxai/core-ui
    • Contains the core ui components for the SolidX UI.

Debugging - VS Code​

Contains editor-specific configurations like launch.json for debugging and IDE behavior.

Upgrade Scripts​

upgrade.sh: Used for upgrading the core SolidX backend/frontend dependencies.

Tips

  • All environment variables are stored in .env files within each app folder.