README.md

threejs-sci-fi-portal-effect

---

Table of Contents

1. Introduction

2. Run the project locally

3. Deployment

   • Deployment – Run locally
   • Deployment – Live website

4. Credits

   • Media

---

Introduction

Creating an animated 3D science fiction portal effect with Three.js

Back to top

---

Run the project locally

Install Vite, a development server with live reload capability.

• To install:

    npm create vite@latest
  

• To run (from your local directory):

    npm run dev
  

Back to top

---

Deployment

Deployment – Run locally

1. Prerequisite:

   • Make sure Node and NPM are installed on your computer. You can download both at nodejs.org (NPM is included in your Node installation).
   • Please see .nvmrc file at the root of threejs-sci-fi-portal-effect repo.
   • Using nvm, a Node Version Manager is recommended as it helps you manage and switch between different Node versions with ease. It provides a command-line interface where you can install different versions with a single command, set a default, switch between them, etc.

2. In GitHub click on the repository nammed threejs-sci-fi-portal-effect

3. Clone the repository locally. Run

     git clone https://github.com/sctlcd/threejs-sci-fi-portal-effect.git
   

4. Install all modules listed as dependencies in package.json

     cd threejs-sci-fi-portal-effect
     npm i 
   

   note: in this app

   • three - a JavaScript 3D library,
   • vite - a built in development server,

5. Install Vite, a development server with live reload capability.

• To install:

    npm create vite@latest
  

• To run (from your local directory):

    npm run dev
  

Back to top

---

Deployment - Live Website

threejs-sci-fi-portal-effect live website is currently deployed on Firebase using the main branch on GitHub. Once you have the project setup locally, you can proceed to deploy it remotely.

1. Install Firebase CLI Tools, firebase-tools

     npm install -g firebase-tools
   

2. Create firebase.json and .firebaserc at the root of your project with the following content:

   firebase.json:

     {
       "hosting": {
         "public": "dist",
         "ignore": [],
         "rewrites": [
           {
             "source": "**",
             "destination": "/index.html"
           }
         ]
       }
     }
   

   .firebaserc:

     {
       "projects": {
         "default": "<YOUR_FIREBASE_ID>"
       }
     }
   

3. After running npm run build, deploy using the command firebase deploy.

=> live link: https://threejs-sci-fi-portal-effect.web.app/

Back to top

---

Credits

-conical spiral equation

Media

• favicon.ico - Flaticon | copyright Freepik
• pngwing.com-4-min.png - Pngwing | copyright unknown
• pngwing.com-1-min.png - Pngwing | copyright unknown
• colored-smoke-png-43277-min.png - Freeiconspng | copyright Ahkâm

Back to top

---