/sample-react-mui

Primary LanguageTypeScript

sample-react-mui

A simple react project

How to use

  1. Run npm install to install all dependencies.
  2. How to start the project:
  • Run npm run dev to start the server in the development mode.
  • Run npm run build to generate build files, and npm run start to start server in production mode. (Use production mode to check dynamic import.)
  1. Open http://localhost:3000 with your browser to see the result.
  • In the development mode, the page will reload if you make edits.

Screenshots

coming soon...

TODO

  • Use MUI
  • Template structure and base style
  • Add routes/pages (Home, device List, device details, vulnerabilities list, vulnerabilities details)
  • Pagination
  • Sort (sorting in tables)
  • export data
  • Search from tables
  • Use a mock API
  • Performance
    • next/dynamic (next/dynamic is a composite of React.lazy() and Suspense)
    • Lighthouse
    • Optimize code
  • Documentation
    • Finalize README.md
    • Screenshots
    • Storybook
  • Check Responsiveness
  • Tests
    • Unit Test
    • E2E Test
    • Interactions by storybook
    • Accessibility
  • CI/CD
  • Config ESLint

Feedback

Please submit an issue on GitHub if you have any feedback

Contributing

Contributions are always welcome!

To contribute to this repository, please make a PR.

Authors

License

MIT

References