Skip to content

Latest commit

 

History

History
82 lines (74 loc) · 4.17 KB

ProjectStructure.md

File metadata and controls

82 lines (74 loc) · 4.17 KB

Clearpath Project Folder Breakdown

Introduction and an indepth explanation:

This project structure follows the Next.js App Router conventions for defining routes using folders and files. Here's an explanation of the different parts:

  1. app/ directory: This is where the Next.js App Router files are located.
    • home/ directory: Contains the home page component and authentication routes for sign-in and login.
    • [dashboard]/ directory: Contains the routes and components for the dashboard section of the application.
      • terminal/ directory: Contains the component for the terminal/dashboard command center.
      • workspace/ directory: Contains the workspace page component and the sprints/ directory.
        • sprints/ directory: Renamed from projects/, this directory contains the routes and components for managing sprints.
          • [sprintId]/ directory: A dynamic route segment for each sprint, containing the sprint page component, a layout component, and a nested tasks/ directory.
          • tasks/ directory: Nested under each [sprintId] directory, this directory contains the routes and components for managing tasks within a specific sprint.
            • [taskId]/ directory: A dynamic route segment for each task, containing the task page component.
      • preferences/ directory: Contains the preferences page component and nested routes for managing personal account settings, notifications, and account deletion.
    • layout.tsx: The root layout component for the application.
    • head.tsx: The component for defining the application's metadata.
    • globals.css: Global styles for the application.
  2. components/ directory: Contains shared React components.
    • component/ directory: For components related to specific features.
    • ui/ directory: For reusable UI components like buttons, inputs, modals, etc.
  3. lib/ directory: Contains utility functions and helpers.
  4. public/ directory: For static assets like images, fonts, etc.
  5. package.json: Project configuration file for managing dependencies.
  6. next.config.js: Next.js configuration file.
  7. .next/ and node_modules/ directories: Generated by Next.js and contain the build output and installed dependencies, respectively.
  8. next-env.d.ts: TypeScript type definitions for the Next.js environment.

Visual representation of the folder structure:

clearpath/
├── .next/ # Next.js build output
├── node_modules/ # Installed dependencies
├── next-env.d.ts # TypeScript type definitions
├── app/
│ ├── home/ # Home Route
│ │ └── page.tsx # Home page component
│ ├── auth/ # Authentication routes
│ │ ├── signin/
│ │ │ └── page.tsx # Sign-in page component
│ │ └── login/
│ │ └── page.tsx # Login page component
│ ├── dashboard/ # Dashboard routes
│ │ ├── terminal/ # Terminal/Dashboard Command Center route
│ │ │ └── page.tsx # Terminal/Dashboard Command Center component
│ │ ├── workspace/ # Workspace routes
│ │ │ ├── page.tsx # Workspace page component
│ │ │ └── sprints/ # Sprints routes (renamed from projects)
│ │ │ ├── [sprintId]/
│ │ │ │ ├── page.tsx
│ │ │ │ ├── tasks/ # Tasks routes (nested under sprints)
│ │ │ │ │ ├── page.tsx
│ │ │ │ │ └── [taskId]/
│ │ │ │ │ └── page.tsx
│ │ │ │ └── layout.tsx
│ │ │ ├── page.tsx
│ │ │ └── layout.tsx
│ │ └── preferences/ # Preferences routes
│ │ ├── page.tsx # Preferences page component
│ │ ├── account/ # Personal account settings
│ │ │ └── page.tsx
│ │ ├── notifications/ # Notifications settings
│ │ │ └── page.tsx
│ │ └── delete-account/ # Delete account
│ │ └── page.tsx
│ ├── layout.tsx
│ ├── head.tsx
│ └── globals.css
├── components/
│ ├── component/
│ └── ui/
├── lib/
├── public/
├── package.json
└── next.config.js

This clearly depicts how the project folder structure should look like; please adhere to it.