Skip to content
This repository has been archived by the owner on Jul 6, 2022. It is now read-only.

smhs-os-project/cscheckin-fe

Repository files navigation

CSCheckin (Frontend)

網課專用,一鍵簽到,基於 Google Classroom 的簽到平台。 立即使用 →

CSC - Homepage CSC - Main CSC - Manage

Codebase features

  • Automatically analyze code after pushing to GitHub
    • Analyze with CodeQL
    • Analyze with njsscan
    • Check if linted with yarn lint
    • Test building production build with yarn build
    • Test building Docker with docker build
  • Available to build as a Docker image
    • Exclude all useless components for a production build
      • For example, storybook and eslint
  • Built-in .vercelignore so that you can install dependencies with yarn --production
    • Exclude all useless components for a production build
      • For example, storybook and eslint
  • Built-in Sentry support
  • Built-in Google Analytics support
  • Built-in NProgress (process bar) support
  • Built-in ESLint support
    • with featured ESLint rules
    • strictly follow the ESLint rules
  • Component Driven User Interfaces
    • Built-in Storybook support

Configure

Copy .env.local.example to .env.local, and edit the corresponding value.

Test

yarn dev   # the Watch Mode of Next.js
yarn lint  # check if the codebase has any issue

Build

yarn build  # Build this codebase
yarn start  # Serve the built artifact

Deploy

You can deploy CSCheckin to any platform. However, We recommended deploying on Vercel:

Deploy with Vercel

License

MIT License.