Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shin-sforzando/splato.one
A service to record your Splatoon3 battles
https://github.com/shin-sforzando/splato.one
nextjs splatoon supabase
Last synced: 2 days ago
JSON representation
A service to record your Splatoon3 battles
- Host: GitHub
- URL: https://github.com/shin-sforzando/splato.one
- Owner: shin-sforzando
- License: mit
- Created: 2022-08-12T17:07:21.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-01-09T03:49:13.000Z (about 2 years ago)
- Last Synced: 2024-05-02T02:21:00.414Z (9 months ago)
- Topics: nextjs, splatoon, supabase
- Language: TypeScript
- Homepage: https://splato.one/
- Size: 41 MB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# splato.one
[](https://github.com/shin-sforzando/splato.one/graphs/commit-activity)
[](https://github.com/shin-sforzando/splato.one/actions/workflows/ci.yml)
[](http://commitizen.github.io/cz-cli/)
[](https://opensource.org/licenses/MIT)
A service to record your Splatoon®3 battles.
- [Prerequisites](#prerequisites)
- [How to](#how-to)
- [Setup](#setup)
- [Reveal secrets](#reveal-secrets)
- [Develop](#develop)
- [Test](#test)
- [Storybook](#storybook)
- [Document](#document)
- [CHANGELOG.md](#changelogmd)
- [Deploy](#deploy)
- [Misc](#misc)
- [Notes](#notes)
- [LICENSE](#license)
- [Contributors](#contributors)
## Prerequisites
- [Supabase](https://app.supabase.com/)
- Node.js
- Next.js
- [next-axiom](https://github.com/axiomhq/next-axiom) as **Logger**
- ESLint
- Prettier
- Stylelint
- Jest
- Playwright
- Storybook
- [git-secret](https://git-secret.io)
## How to
```shell
$ yarn run
- 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](https://commitizen.github.io/cz-cli/) friendly, following [GitHub flow](https://docs.github.com/en/get-started/quickstart/github-flow).
See [CONTRIBUTING.md](./CONTRIBUTING.md) for details.
### LICENSE
"Splatoon" is registered trademark of Nintendo.
This project is licensed under the MIT License, see the [LICENSE](./LICENSE) for details.
### Contributors
- [sforzando LLC. and Inc.](https://sforzando.co.jp/)
- [Shin'ichiro Suzuki](https://github.com/shin-sforzando)