README.md

Introduction

Satūs means start, beginning, planting, it's a set of tools we use as a template when starting a new project.

Composition

This starter kit is composed of:

• Next.js
• Lenis
• Theatre.js
• GSAP
• Hamo
• Compono

Features

This starter kit is composed of:

• react-three-fiber
• SVG import through @svgr/webpack
• Sass architecture and tooling:
  • Config file
  • Viewport based sizes
  • Reset
  • Easings
  • Themes
• Debug tools:
  • Theatre.js Studio
  • FPS Meter
  • Grid Debugger
• Github workflow to display lighthouse report on slack: make sure you update the vercel_project_id in .github/workflows/lighthouse-on-vercel-preview-url.yml to your Vercel project id.

Debug

To toggle debug modes you need to access the page /_debug/orchestra.

example: https://satus.studiofreight.com/_debug/orchestra

Flavors

• Light (you're here)
• With Shopify
• With Contentful
• With react-three-fiber
• With OGL

Authors

This toolkit is curated and maintained by the Studio Freight Things team:

• Clement Roche (@clementroche_) – Studio Freight
• Guido Fier (@uido15) – Studio Freight
• Leandro Soengas (@lsoengas) - Studio Freight
• Franco Arza (@arzafran) - Studio Freight

License

The MIT License.