Skip to content

coslynx/hyperview-3d-landing

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

47 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

hyperview-3d-landing

Showcase SaaS products with interactive 3D landing pages

Developed with the software and tools below.

React Three.js TypeScript Tailwind CSS
git-last-commit GitHub commit activity GitHub top language

๐Ÿ“‘ Table of Contents

  • ๐Ÿ“ Overview
  • ๐Ÿ“ฆ Features
  • ๐Ÿ“‚ Structure
  • ๐Ÿ’ป Installation
  • ๐Ÿ—๏ธ Usage
  • ๐ŸŒ Hosting
  • ๐Ÿ“„ License
  • ๐Ÿ‘ Authors

๐Ÿ“ Overview

This repository showcases a 3D landing page for SaaS products built using React, Three.js, and TypeScript, providing an interactive experience.

๐Ÿ“ฆ Features

Feature Description
๐Ÿ”ท Interactive 3D Models Utilizes Three.js and React Three Fiber for rendering interactive 3D models, enabling users to explore products in detail.
โœจ Animations Leverages GSAP and Framer Motion for creating smooth, engaging animations and transitions, enhancing the user experience.
๐Ÿ“ฑ Responsive Design Designed to adapt seamlessly across various devices, ensuring a consistent and engaging experience on desktops, tablets, and mobile phones. Built with Tailwind CSS.
๐ŸŒ™ Theme Switching Allows users to toggle between light and dark themes using a custom hook, providing a personalized viewing experience.
๐Ÿš€ Performance Optimized Implements memory management, lazy loads 3D objects and uses LOD to deliver smooth and performant renders.
๐Ÿ’Ž Customizable Materials The ability to apply textures and themes to enhance the scene.
๐ŸŽญ Base Template The ability to setup threejs quickly with base elements like lights, camera, and more.
๐ŸŽฎ Interaction Support This allows for users to use mouse or keyboard to move aroudn the created 3D scene.

๐Ÿ“‚ Structure

3d-landing-page/
โ”œโ”€โ”€ src/
โ”‚   โ”œโ”€โ”€ components/          # Reusable React components
โ”‚   โ”‚   โ”œโ”€โ”€ 3d/              # Three.js related components
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ core/      # scene, camera, renderer
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ models/    # 3D assets
โ”‚   โ”‚   โ”‚   โ””โ”€โ”€ effects/   # shaders, postprocessing
โ”‚   โ”‚   โ”œโ”€โ”€ layout/          # viewport, containers
โ”‚   โ”‚   โ””โ”€โ”€ sections/        # hero, features
โ”‚   โ”œโ”€โ”€ hooks/             # animation, scroll, three
โ”‚   โ”œโ”€โ”€ pages/             # index, model
โ”‚   โ”œโ”€โ”€ styles/            # theme, components
โ”‚   โ”œโ”€โ”€ utils/             # three, animation, perf
โ”‚   โ”œโ”€โ”€ App.tsx              # Application
โ”‚   โ”œโ”€โ”€ main.tsx             # Application
โ”‚   โ””โ”€โ”€ vite-env.d.ts       # Environment
โ”œโ”€โ”€ index.html           # HTML
โ”œโ”€โ”€ vite.config.ts       # Vite
โ”œโ”€โ”€ tailwind.config.js   # Tailwind
โ”œโ”€โ”€ tsconfig.json        # Typescript
โ”œโ”€โ”€ README.md            # Info
โ”œโ”€โ”€ package.json         # Dependencies

๐Ÿ’ป Installation

Warning

๐Ÿ”ง Prerequisites

  • Node.js v18+
  • npm 6+

๐Ÿš€ Setup Instructions

  1. Clone the repository:

    git clone https://github.com/coslynx/hyperview-3d-landing.git
    cd hyperview-3d-landing
  2. Install dependencies:

    npm install

๐Ÿ—๏ธ Usage

๐Ÿƒโ€โ™‚๏ธ Running the MVP

  1. Start the development server:

    npm run dev
  2. Access the application:

Tip

โš™๏ธ Configuration

No need for much configuration, only to provide the API and connect the different features to the server

๐Ÿ“š Examples

Provide specific examples relevant to the MVP's core features. For instance:

  • 3D model configuration:

    <ModelLoader modelUrl="/models/scene.glb" />
  • Base ThreeJS Setup:

            <ThreeScene >
                  ... components
            </ThreeScene>
  • Landing Page:

                <LandingHero
                      modelUrl="/models/laptop.glb"
                      headline="Experience Immersive 3D Web Design"
                      subheadline="Create stunning, interactive 3D landing pages with ease."
                      ctaLabel="Get Started"
                      ctaLink="/models"
                    />

๐ŸŒ Hosting

๐Ÿš€ Deployment Instructions

Provide detailed, step-by-step instructions for deploying to the most suitable platform for this MVP. For example:

Deploying to Netlify

  1. Build the project:
npm run build
  1. Drag and drop the 'dist' folder. You will get a web address for the website and you can assign it to a domain or subdomain you have.

๐Ÿ“„ License & Attribution

Note

๐Ÿ“œ License & Attribution

๐Ÿ“„ License

This Minimum Viable Product (MVP) is licensed under the GNU AGPLv3 license.

๐Ÿค– AI-Generated MVP

This MVP was entirely generated using artificial intelligence through CosLynx.com.

No human was directly involved in the coding process of the repository: hyperview-3d-landing

๐Ÿ“ž Contact

For any questions or concerns regarding this AI-generated MVP, please contact CosLynx at:

๐ŸŒ CosLynx.com

Create Your Custom MVP in Minutes With CosLynxAI!