Project Description

Ai-house is a three.js learning project that utilizes a GLTF model loaded into the web environment. This project serves as the website for AI @ Princeton, an organization focused on teaching students on campus about developments and opportunities in the field of AI and machine learning.

View Product · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Roadmap
4. Contributing
5. License
6. Contact
7. Acknowledgments

About the Project

(back to top)

Built With

• 
• 
• 
• 
• 

(back to top)

Getting Started

Below, I have included the necessary steps to set up ai-house locally.

Prerequisites

To run this project, you must download the latest version of the npm package manager and Blender 3.6.1.

npm install npm@latest -g

Installation

1. Clone the repo

   git clone https://github.com/Shivamkak19/ai-house.git

2. Install NPM packages

   npm install

3. Vite local deployment

   npm run dev

4. Vite build

   npm run build

5. Vite preview

   npm run preview

(back to top)

Roadmap

• Design 3D model in Blender
  • Export GLTF, import in three.js scene via DracoLoader
• Construct Three.js scene via Singleton design pattern
• Overlay scene onto HTML/CSS

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

If you have a suggestion that would make this project better, please feel free to fork the repo, expirement with features of your own, and create a pull request. You can also simply open an issue with the tag "enhancement".

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/newFeature)
3. Commit your Changes (git commit -m 'Add some new feature to ai-house')
4. Push to the Branch (git push origin feature/newFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

• Alex Zhang: [email protected]
• Shivam Kak: [email protected]
• Project Link: https://github.com/Shivamkak19/ai-house

(back to top)

Acknowledgments

• Woan Coding, three.js dev youtuber (https://www.youtube.com/@pandawoan) for blender and three.js instruction.
• Chris Courses, web development youtuber (https://www.youtube.com/@ChrisCourses), for tutorials on three.js scene creation.
• Tadeus, 3D graphics artist, for the blender model of the low-poly tiger available as:

"Low Poly - Tiger" (https://skfb.ly/6YOEX) by tadeus is licensed under Creative Commons Attribution (http://creativecommons.org/licenses/by/4.0/).

(back to top)