https://github.com/soundux/website
πΈοΈπ Next-gen website for Soundux
https://github.com/soundux/website
Last synced: 10 months ago
JSON representation
πΈοΈπ Next-gen website for Soundux
- Host: GitHub
- URL: https://github.com/soundux/website
- Owner: Soundux
- License: gpl-3.0
- Created: 2022-08-02T19:34:42.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2022-08-02T20:12:35.000Z (almost 4 years ago)
- Last Synced: 2025-03-01T10:16:46.498Z (over 1 year ago)
- Language: TypeScript
- Homepage: https://new.soundux.rocks
- Size: 598 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Soundux Website
Website for [Soundux](https://github.com/Soundux/Soundux)
[](https://github.com/Soundux/Soundux)
[](https://github.com/Soundux/website/blob/master/LICENSE)
[](https://github.com/Soundux/website/actions/workflows/cd.yml)
[](https://github.com/prettier/prettier)
> β οΈ The repo's `master` branch contains the source files for the site. The static files are in the [`gh-pages` branch](https://github.com/Soundux/website/tree/gh-pages)!
### Tech stack
[](https://nextjs.org/)
[](https://mantine.dev/)
## Features
This template comes with several essential features:
- Server side rendering setup for Mantine
- Color scheme is stored in cookie to avoid color scheme mismatch after hydration
- Storybook with color scheme toggle
- Jest with react testing library
- ESLint setup with [eslint-config-mantine](https://github.com/mantinedev/eslint-config-mantine)
## npm scripts
### Build and dev scripts
- `dev` β start dev server
- `build` β bundle application for production
- `export` β exports static website to `out` folder
- `analyze` β analyzes application bundle with [@next/bundle-analyzer](https://www.npmjs.com/package/@next/bundle-analyzer)
### Testing scripts
- `typecheck` β checks TypeScript types
- `lint` β runs ESLint
- `prettier:check` β checks files with Prettier
- `jest` β runs jest tests
- `jest:watch` β starts jest watch
- `test` β runs `jest`, `prettier:check`, `lint` and `typecheck` scripts
### Other scripts
- `storybook` β starts storybook dev server
- `storybook:build` β build production storybook bundle to `storybook-static`
- `prettier:write` β formats all files with Prettier