splato.one

A service to record your Splatoon®3 battles.

• Prerequisites
• How to
  • Setup
    • Reveal secrets
  • Develop
  • Test
  • Storybook
  • Document
    • CHANGELOG.md
  • Deploy
• Misc
  • Notes
  • LICENSE
  • Contributors

Prerequisites

• Supabase
• Node.js
  • Next.js
    • next-axiom as Logger
  • ESLint
  • Prettier
  • Stylelint
  • Jest
  • Playwright
  • Storybook
• git-secret

How to

$ yarn run
<snip>
   - build
      next build
   - build-storybook
      build-storybook
   - chromatic
      npx chromatic --project-token=$CHROMATIC_PROJECT_TOKEN
   - dev
      next dev
   - hide
      git secret hide
   - lint
      next lint --dir src
   - lint:fix
      yarn lint --fix
   - prepare
      husky install
   - prettier
      prettier --write './**/*.{js,jsx,ts,tsx,json}'
   - reveal
      git secret reveal
   - start
      next start
   - storybook
      start-storybook -p 6006
   - stylelint
      stylelint --fix './**/*.{css,scss,sass}'
   - test
      yarn test:jest && yarn test:e2e
   - test:e2e
      playwright test
   - test:jest
      jest --updateSnapshot
   - test:watch
      jest --watchAll

Setup

Reveal secrets

To reveal secret files, yarn reveal.

To hide secret files, yarn hide.

Develop

yarn dev to start development server.

Test

To test using Jest, yarn test:jest.

To test using Playwright, yarn test:e2e.

To test both, yarn test.

Storybook

Every time you push to GitHub, it is automatically deployed to Chromatic.

yarn storybook to open Storybook manually.

Document

CHANGELOG.md

To update CHANGELOG.md, git cliff --unreleased --output CHANGELOG.md.

Deploy

Every time you push to GitHub, it is automatically deployed to Vercel.

Misc

Notes

This repository is Commitizen friendly, following GitHub flow. See CONTRIBUTING.md for details.

LICENSE

"Splatoon" is registered trademark of Nintendo.

This project is licensed under the MIT License, see the LICENSE for details.

Contributors

• sforzando LLC. and Inc.
  • Shin'ichiro Suzuki