Overview

Satūs is a starter kit composed of Next.js, Lenis, Theatre.js, GSA, and HamoCompono. It provides a set of tools that can be used as a template when starting a new project.

Features

• SVG import through @svgr/webpack
• Sass architecture and tooling
• Config file for viewport-based sizes
• Reset and easings
• Themes and debug tools
• Theatre.js Studio for animation effects
• FPS Meter and Grid Debugger
• Github workflow integration for displaying lighthouse reports on Slack

Installation

To install the Satūs starter kit, follow these steps:

1. Make sure you have Node.js and npm installed on your machine.
2. Run the following command in your terminal to clone the repository:

git clone [repository_url]

3. Navigate to the cloned directory:

cd [directory_name]

4. Install the dependencies:

npm install

5. Update the vercel_project_id in the .github/workflows/lighthouse-on-vercel-preview-url.yml file to your Vercel project ID.

6. To toggle debug modes, access the page /_debug/orchestra on your website URL. For example:

https://example.com/_debug/orchestra

Summary

Satūs is a comprehensive starter kit for web development projects. It offers features like SVG import, Sass architecture, viewport-based sizes, themes, debug tools, and more. The starter kit is curated and maintained by the Studio Freight Things team and is licensed under the MIT License.