Skip to content

Latest commit

 

History

History
32 lines (26 loc) · 2.83 KB

package.md

File metadata and controls

32 lines (26 loc) · 2.83 KB

Documentation for package.json

The goals of this document are:

  • Giva an overview of the dependencies we are using and for what
  • Notes on versions and why/when to update/not update them

Dependencies

  • 'react react-dom' - React JS (Browser) is used to build the user interface
  • '@mui/material @emotion/react @emotion/styled' - Material UI is a library of React UI components that implements Google's Material Design, styling is done with Emotion
  • 'axios' - Axios is a promise based HTTP client for the browser and node.js
  • 'react-router-dom' - React Router makes routing between different pages possible
  • 'i18next, i18next-browser-languagedetector, react-i18next' - internationalization of the UI with i18next
  • '@auth0/auth0-react' - Auth0 setup for token authentication

DevDependencies

  • 'express json-server' - runs a local server to mock APIs with JSON Server
  • 'clean-webpack-plugin' - cleans the build folder
  • 'webpack webpack-cli @types/webpack webpack-dev-server @types/webpack-dev-server babel-loader html-webpack-plugin ts-node fork-ts-checker-webpack-plugin @types/fork-ts-checker-webpack-plugin eslint-webpack-plugin clean-webpack-plugin' - webpack creates performant bundles containing our app’s JavaScript code
  • 'eslint eslint-plugin-react eslint-plugin-react-hooks @typescript-eslint/parser @typescript-eslint/eslint-plugin' - ESLint lints our code
  • '@babel/core @babel/preset-env @babel/preset-react @babel/preset-typescript @babel/plugin-transform-runtime @babel/runtime' - Babel converts React and TypeScript code to JavaScript
  • 'typescript @types/react @types/react-dom' - Typescript extends Javascript by adding types
  • 'css-loader style-loader' - to bundle css files into the build we should be able to remove this when switching to Emotion for all styling
  • 'fork-ts-checker-webpack-plugin' - webpack plugin that runs TypeScript type checker on a separate process
  • 'gh-pages' - allows us to easily deploy to GitHub Pages
  • 'html-webpack-plugin' - plugin that simplifies creation of HTML files to serve your bundles
  • 'jest' - Jest for unit testing for all testing needs
  • '@testing-library/user-event @testing-library/user-event' - React Testing Library makes user centric testing of React components easier
  • 'clean-webpack-plugin' - cleans the build folder