Add some simple documentation
All checks were successful
continuous-integration/drone/push Build is passing
All checks were successful
continuous-integration/drone/push Build is passing
This commit is contained in:
parent
bcf84b1f39
commit
822cd4107d
2 changed files with 111 additions and 0 deletions
73
docs/Dependencies.md
Normal file
73
docs/Dependencies.md
Normal file
|
@ -0,0 +1,73 @@
|
|||
# Dependencies
|
||||
|
||||
This document briefly explains the different dependencies located in the `package.json`.
|
||||
|
||||
This document will not explain how to use them. You can read their documentation for that and the codebase have exemples for references.
|
||||
|
||||
|
||||
# [React](https://reactjs.org/)
|
||||
|
||||
Main framework to build the js application.
|
||||
|
||||
It depends on Vite in order to build the project.
|
||||
|
||||
Others dependencies:
|
||||
- [react-dom](https://reactjs.org/docs/react-dom.html): library used to inject the app to `#root` html element.
|
||||
- [react-svg-pan-zoom](https://www.npmjs.com/package/react-svg-pan-zoom): component that offers pan + zoom to a svg element
|
||||
|
||||
|
||||
# [Vite](https://vitejs.dev/)
|
||||
|
||||
Vite is the main tool to develop the react application.
|
||||
|
||||
Its uses the following files to configure the project :
|
||||
- `vite.config.ts`
|
||||
- `.env*`
|
||||
- `src/vite-env.d.ts`
|
||||
|
||||
Others dependencies:
|
||||
- @vitejs/plugin-react
|
||||
|
||||
|
||||
# [Tailwind CSS](https://tailwindcss.com/)
|
||||
|
||||
CSS framework designed around constraints with utility classes in order to reduce dead css code.
|
||||
|
||||
Its uses the following files to configure the project :
|
||||
- `src/index.scss`
|
||||
- `tailwind.config.cjs`
|
||||
- `postcss.config.cjs`
|
||||
|
||||
Other dependencies:
|
||||
- postcss
|
||||
- sass
|
||||
- autoprefixer
|
||||
|
||||
|
||||
# [Heroicons](https://heroicons.com/)
|
||||
|
||||
SVG Icons that can be used as JSX elements with Tailwind CSS
|
||||
|
||||
|
||||
# Testing
|
||||
|
||||
- [Vitest](https://vitest.dev/)
|
||||
- [Testing Library](https://testing-library.com/)
|
||||
- [jsdom](https://github.com/jsdom/jsdom)
|
||||
|
||||
|
||||
# [eslint](https://eslint.org/)
|
||||
|
||||
A Linter. Used for error checking, syntax checking and code style enforcing.
|
||||
|
||||
Currently using `standard-with-typescript` with a few modification.
|
||||
|
||||
See the `.eslintrc.cjs` for more informations.
|
||||
|
||||
Other dependencies:
|
||||
- typescript-eslint/eslint-plugin
|
||||
- typescript-eslint/parser
|
||||
- eslint-plugin-import
|
||||
- eslint-plugin-n
|
||||
- eslint-plugin-promise
|
||||
- eslint-plugin-react
|
Loading…
Add table
Add a link
Reference in a new issue