Welcome to the Matat Web Application
Copy the .env.example to .env and fill in any missing environment variables
// 🍪 ensure your npm version is 10
npm -v // 10
// 💥 ensure your node version is 20
node -v //20
// 💻 install node_modules
npm i
// 🚀 run
npm run dev
The Matat WEB Application is built with React and Vite.
Below are some common commands you will need to know in order to work in this repository
| Command | Description |
|---|---|
| dev | Run local Vite Dev Server |
| build | Builds a distributable webapp artifact |
| preview | Serves the artifact built in the dist folder |
| test | Runs all test files-- -u to update the test snapshots-- --ui to run with the vitest dashboard |
| lint | Checks the project for code that fails the lint rules lint:fix to apply fixes |
| storybook | Run a local Storybook server |
We have provided a handful of suggested IDE extension's to use when working with this repository. You can choose if you would like to use these extensions or not. New extensions can be added at anytime with approval from other team member in the form of a PR.
These suggestions will appear when first launching VSCode in the workspace or when you goto the Recommendations sections in the Extensions view.
| Extension Name | Description | URL |
|---|---|---|
| Code Spell Checker | Spelling checker for source code | VS Marketplace |
| Git Graph | View a Git Graph of your repository, and perform Git actions from the graph. | VS Marketplace |
| VSCode Remote | View remote machines for Remote - SSH and Remote Server | VS Marketplace |
👉 Full Project Description: Check out the docs/overview.md file for detailed information.