Getting Started
File Structure

File Structure

The tree diagram below illustrates the file structure and contents of the Neo Start Kit package.

root
β”œβ”€β”€ πŸ“‚public/
β”‚ └── πŸ“‚media           # Static assets like images, fonts, etc.
β”œβ”€β”€ πŸ“‚src/
β”‚ β”œβ”€β”€ πŸ“‚api             # API endpoints and mock data
β”‚ β”œβ”€β”€ πŸ“‚auth            # Authentication module and components
β”‚ β”œβ”€β”€ πŸ“‚components      # Reusable UI components
β”‚ β”œβ”€β”€ πŸ“‚config          # Configuration files for the app
β”‚ β”œβ”€β”€ πŸ“‚errors          # Error pages
β”‚ β”œβ”€β”€ πŸ“‚features        # Feature-specific modules
β”‚ β”œβ”€β”€ πŸ“‚hooks           # Custom React hooks.
β”‚ β”œβ”€β”€ πŸ“‚i18n            # Internationalization files.
β”‚ β”œβ”€β”€ πŸ“‚layouts         # Layout components that structure pages.
β”‚ β”œβ”€β”€ πŸ“‚pages           # App-level pages.
β”‚ β”œβ”€β”€ πŸ“‚partials        # Partials for smaller reusable sections.
β”‚ β”œβ”€β”€ πŸ“‚providers       # Context providers for managing app-wide state.
β”‚ β”œβ”€β”€ πŸ“‚routing         # Routing-related files.
β”‚ β”œβ”€β”€ πŸ“‚scss            # SCSS files for global and modular styles.
β”‚ β”œβ”€β”€ πŸ“‚store           # Redux or other state management store configuration.
β”‚ β”œβ”€β”€ πŸ“‚types           # TypeScript type definitions and interfaces
β”‚ β”œβ”€β”€ πŸ“‚utils           # Utility functions and helpers.
β”‚ β”œβ”€β”€ App.tsx           # Main app component, the entry point for React's component tree.
β”‚ β”œβ”€β”€ main.tsx          # Main entry point for rendering the app, initializing providers, and attaching the app to the DOM.
β”‚ └── vite-env.d.ts     # Vite-specific TypeScript environment definitions.
β”œβ”€β”€ .env                # Environment variables configuration file.
β”œβ”€β”€ .eslintignore       # Files and directories ignored by ESLint.
β”œβ”€β”€ .eslintrc.cjs       # ESLint configuration file in CommonJS format.
β”œβ”€β”€ .gitignore          # Files and directories ignored by Git.
β”œβ”€β”€ components.json     # Configuration or metadata for ShadcnUI components.
β”œβ”€β”€ eslint.config.js    # ESLint configuration file.
β”œβ”€β”€ index.html          # The main HTML file that serves the app.
β”œβ”€β”€ package-lock.json   # Automatically generated file for locking npm dependencies.
β”œβ”€β”€ package.json        # Defines the project's dependencies, scripts, and metadata.
β”œβ”€β”€ postcss.config.js   # Configuration file for PostCSS, used for CSS processing.
β”œβ”€β”€ README.md           # Documentation for the project.
β”œβ”€β”€ tailwind.config.js  # Configuration for Tailwind CSS.
β”œβ”€β”€ tsconfig.app.json   # TypeScript configuration specific to the app.
β”œβ”€β”€ tsconfig.json       # Main TypeScript configuration file.
β”œβ”€β”€ tsconfig.node.json  # TypeScript configuration specific to Node.js.
β”œβ”€β”€ vercel.json         # Configuration for deploying the app on Vercel.
└── vite.config.json    # Configuration file for Vite build and development server.