NT3

This template provides a starting point for building Next.js apps with Tailwind CSS, TypeScript and Three.js.

How to install

  # Clone the project
  git clone https://github.com/whosramoss/nt3/

  # Go to the project directory
  cd nt3

  # Install dependencies
  npm install

  # Start the server
  npm run dev

How to build

• Before generating the build, don't forget to update the layout file and set isLocalMetadata = false.
• To generate a static compilation, the next.config.mjs file must have the object below :

const staticbuild = {
  distDir: 'build',
  output: 'export',
  trailingSlash: true,
}

• Run the command:

  npm run build

Project Modular Structure Overview

src/
├── app/
│   ├── manifest.ts
│   ├── layout.tsx
│   ├──page.tsx
│   └── [lang]/
│         └── page.tsx/
├── modules/
│   └── {module-name}/
│       ├── components/
│       ├── services/
│       ├── schemas/
│       └── data/
└── shared/
    ├── ui/
    ├── styles/
    ├── providers/
    ├── utils/
    └── hooks/

Framework and Packages

• Next.js
• TypeScript
• Prettier
• ESLint
• Tailwind CSS
• Framer Motion
• Zod

Hooks

• useAnimationCursor
• useAnimationFadeIn
• useFetch (Using React-Query)

Contributing

If you want to contribute to nt3, please make sure to review the contribution guidelines. This project makes use of GitHub issues for tracking requests and bugs.

License

MIT License. LICENSE

Author

Gabriel Ramos (@whosramoss)