Skip to content

CODEBASE_OVERVIEW.md

Latest commit

 

History

History
64 lines (55 loc) · 1.35 KB

CODEBASE_OVERVIEW.md

File metadata and controls

64 lines (55 loc) · 1.35 KB
Raw

StellarLift Codebase Overview

This document provides an overview of the StellarLift project structure and its main components.

Project Structure

CONTRIBUTING.md
next-env.d.ts
next.config.js
package.json
postcss.config.js
README.md
tailwind.config.js
tsconfig.json
app/
  globals.css
  layout.tsx
  page.tsx
  dashboard/
    page.tsx
  profile/
    page.tsx
  projects/
    page.tsx
    [id]/
      page.tsx
components/
  DripCard.tsx
  Footer.tsx
  Navbar.tsx
  ProjectCard.tsx
lib/
  mockData.ts
  stellar.ts
  store.ts
  utils.ts

Key Folders and Files

  • app/: Contains main application pages and layouts, including dashboard, profile, and projects (with dynamic routing for project IDs).
  • components/: Reusable React components such as Navbar, Footer, DripCard, and ProjectCard.
  • lib/: Utility and data files, including mock data, store management, and helper functions.
  • package.json: Project dependencies and scripts.
  • tailwind.config.js: Tailwind CSS configuration.
  • tsconfig.json: TypeScript configuration.

Getting Started

  1. Install dependencies: 
    npm install
  2. Run the development server: 
    npm run dev

Contribution

See CONTRIBUTING.md for guidelines.

This file was auto-generated to provide a quick reference for the codebase structure and main files.