LibSense client

Frontend of NYU Shanghai Library WMS

Changelog

Prerequisites

• Node.js >= v16.15.1
• Yarn >= 3.3.1

Commands

• yarn install - Install dependencies
• yarn run start - Start development server
• yarn run build - Build production bundle
• yarn run analyze-bundle - Build and analyze production bundle
• yarn run type-check - Run TypeScript type checking
• yarn run lint - Run ESLint, stylelint, and Prettier
• yarn run lint:fix - Run ESLint, stylelint, and Prettier and fix errors
• yarn run commit - Commit changes with commitizen
• yarn run release - Create a new release with standard-version

Tech Stack

• Framework - React
• Page Routing - React Router
• State Management - @reduxjs/toolkit
• UI Library - Ant Design

Building System

Bundler:

• Bundler - webpack
• Code Transpiler - Babel (Babel for transpiling, tsc for types)

Linters:

• JS/TS Linter - ESLint
• CSS Linter - stylelint
• Code Prettier - Prettier

CI:

• Local CI - Husky + lint-staged
• Commit Message Linter - commitlint
• Commit and Release Utilities - commitizen + standard-version

Project Structure

• patches - Patches for dependencies
• src - Source code of the application
  • assets - Images and fonts
  • components - Components
  • constants - Constants of the application
  • hooks - React hooks
  • routes - Pages of the application
  • services - API of the RTK query
  • slices - Redux stores
  • styles - Style files
  • templates - HTML templates for the building system
  • types - Type definitions
  • utils - Utilities for the application
  • app.less - Global styles
  • app.tsx - Application entry point
  • store.ts - Global Redux store
  • externals.d.ts - Global TypeScript declarations
• utils - Utilities for the building system

TODO List

• Containerize the application
• Replace session with token for authentication
• Review fallback values in the whole application for undefined, null and ''