Tridimenzion 🎨

Tridimenzion is a gallery of 3D ART, showcasing various artworks created using Three.js, React Three Fiber, and Drei. This project is built with a modern tech stack, including TypeScript, Next.js, Styled Components, Jest, React Testing Library, Storybook, Eslint, Prettier, and Husky.

Project Goals 🎯

• Increase Test Coverage: One of the goals of this project is to increase the test coverage to ensure robustness and reliability of the application.

• Refine Componentization: The project aims to refine the componentization for better maintainability, reusability, and readability of the codebase.

• Improve Polishing: Initially, this project was developed rapidly, and as a result, certain aspects may not be as polished. The goal is to iterate and improve on these aspects to enhance the overall user experience and code quality.

Tech Stack 🛠️

• TypeScript: Strongly typed superset of JavaScript.
• NextJS: React-based framework for server-side rendering and static site generation.
• Styled Components: CSS-in-JS library for styled components.
• Three.js: JavaScript library for creating 3D graphics.
• React Three Fiber: A React renderer for Three.js.
• Drei: Collection of useful Three.js components.
• Jest: JavaScript testing framework.
• React Testing Library: Testing utility for React.
• Storybook: Tool for building and documenting components.
• Eslint: Linting utility for maintaining code consistency.
• Prettier: Code formatter for consistent code style.
• Husky: Git hooks tool.

Available Commands 🚀

• dev: Run the application on localhost:3000.
• build: Create the production build version.
• start: Start a simple server with the production build code.
• lint: Run the linter on all components and pages.
• test: Run Jest to test all components and pages.
• test:watch: Run Jest in watch mode.
• storybook: Run Storybook on localhost:6006.
• build-storybook: Create the build version of Storybook.

Installation 🚀

1. Clone the repository:

   git clone https://github.com/gui25/tridimenzion.git
   cd tridimenzion
   

2. Install dependencies:

   npm install
   # or
   yarn install
   

3. Usage 🏃‍♂️:

   To start the development server, run:

   npm run dev
   # or
   yarn dev
   

This will start the Next.js development server, and you can access the project at http://localhost:3000.

3D Integration 🎨

This project integrates Three.js for 3D rendering using React Three Fiber (react-three-fiber) and Drei.

Contributing 🤝

Feel free to contribute to this project! Open an issue or submit a pull request to suggest improvements or add new features.

License 📝

This project is licensed under the MIT License.