Getting Started

Directory Structure

Learn about the project structure of Singularities AI latest version.

Singularities AI is a full-stack application built with Spring Boot (Java) for the backend and Nuxt 4 (TypeScript/Vue) for the frontend. The project is containerized using Docker and follows a modular, feature-based architecture.

Global Structure

singularities-ai/
├── README.md
├── LICENSE.txt
├── docker-compose.yml
├── backend/          # Spring Boot backend
│   ├── Dockerfile
│   ├── mvnw
│   ├── mvnw.cmd
│   ├── pom.xml
│   ├── src/
│   │   └── main/
│   │       ├── java/com/singularities/api/
│   │       │   ├── SingularitiesAIApiApplication.java
│   │       │   ├── config/          # Configuration classes
│   │       │   ├── controller/      # REST controllers
│   │       │   ├── data/            # Data layer (entities, repositories, DTOs)
│   │       │   ├── exception/       # Custom exceptions and handlers
│   │       │   ├── filter/          # Security filters
│   │       │   ├── mapper/          # DTO mappers
│   │       │   └── service/         # Business logic
│   │       └── resources/
│   │           ├── application.properties
│   │           ├── db/migration/    # Flyway migrations
│   │           └── email/           # Email templates
│   └── .mvn/wrapper/
└── frontend/         # Nuxt 4 frontend
    ├── Dockerfile
    ├── package.json
    ├── playwright.config.ts
    ├── nuxt.config.ts
    ├── tsconfig.json
    ├── app/
    │   ├── app.vue
    │   ├── assets/styles/          # Global styles
    │   ├── components/             # Vue components
    │   ├── composables/            # Vue composables
    │   ├── interfaces/             # TypeScript interfaces
    │   ├── layouts/                # Layouts
    │   ├── middleware/             # Route middleware
    │   ├── pages/                  # Pages (routes)
    │   ├── plugins/                # Plugins
    │   ├── stores/                 # Pinia stores
    │   └── utils/                  # Utilities
    ├── modules/                    # Nuxt modules
    ├── public/                     # Static assets
    ├── tests/                      # Playwright tests
    └── server/                     # Server-side code

Support

For questions, suggestions, or assistance, open an issue or contact contact@singularities-ai.com.