Skip to content

Kitty-Inu-DAO/Website

Repository files navigation

Release Version release-date CI Tests commit-activity pr-activity closed-issues contributors

License: MIT License: CC BY-NC-ND 4.0

Next-JS IPFS ENS

twitter

Kitty Inu DAO

Kitty Inu DAO Website

Installation

npm

The recommendation is to clone this repository and run:

npm install

Then

npm run build

Dependencies

🗻 Features

  • Automatically inject r3f component in the Canvas
  • Support glsl imports
  • PWA Support
  • Layout for Canvas and DOM
  • Template for the meta data and header
  • Clean code using ESlint and Prettier
  • VSCode debug profiles for the server, Chrome, and Firefox

🚄 Architecture

Inform the nextjs page that the component is a Threejs component. For that, simply add the r3f property to the parent component.

const Page = (props) => {
  return (
    <>
      <div>Hello !</div>
    </>
  )
}
// canvas components goes here
// It will receive same props as Page component (from getStaticProps, etc.)
Page.r3f = (props) => (
  <>
    <Shader />
  </>
)

export default Page

🎛️ Available Scripts

  • yarn dev - Next dev
  • yarn analyze - Generate bundle-analyzer
  • yarn lint - Audit code quality
  • yarn build - Next build
  • yarn start - Next start
  • yarn export - Export to static HTML

⬛ Stack

Feedback

Please feel free to:

Copyright and License

see COPYRIGHT and LICENSE files for copyright and license information.

Licensed Works

All materials under /public/3D/ are licensed under a Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International. See COPYRIGHT for more details.

Contributing

  • All contributions should be made as a pull request to the dev branch. Pull requests to main will be ignored.

  • PRs must include a concise but descriptive title of the feature, bug, chore, etc. the PR is addressing.

  • This repository follows conventional commit semantics. Please read here to ensure you understand the proper commit format: https://www.conventionalcommits.org/en/v1.0.0/#summary

Deployment

  • This repository uses Fleek for deployments of the main branch to IFPS.
  • ENS is used as the domain.

Browsers with ENS support

Production deployment at: https://kitty-inu-dao.eth/

All Other Browsers:

Cloudflare with .link

Production deployment at: https://kitty-inu-dao.eth.link/

Centralized way to access information in the ENS from DNS, managed by Cloudflare.

Preferred: Wildcarded DNS Record

Production deployment at: https://kitty-inu-dao.eth.limo/

Decentralized alternative to eth.link. Similar to eth.link, eth.limo is based on a wildcarded DNS record, *.eth.limo. However, instead of being managed by a single organization, it is powered by a DAO.