DIY Store is a web application built for do-it-yourself enthusiasts. It aims to provide a platform where users can find and purchase various DIY products, tools, and materials. The project is developed using TypeScript, Vite, and Jest to ensure a robust and efficient development experience.
Make sure you have the following tools installed on your system:
Node.js (v14 or later)
NPM (Node Package Manager)
- Clone this repository to your local machine:
git clone https://github.com/joaopaulosf/diy-store.git- Change your current directory to the project folder:
cd diy-store- Install the project dependencies using npm:
npm installTo run the development server and start working on the DIY Store project, use the following command:
npm run devThis will launch the Vite development server, and you can access the application in your browser at http://localhost:5173
The project is equipped with unit tests to ensure its reliability and maintainability. To run the tests, use the following command:
npm run testIf you want to collect code coverage during testing, you can use:
npm run test:covThe coverage report will be generated in the project's directory for further analysis.
To build the DIY Store application for production, use the following command:
npm run buildThis command will transpile TypeScript code using TypeScript compiler (tsc) and bundle the application using Vite. The production-ready files will be available in the dist folder.
We have set up ESLint to maintain a consistent code style and identify potential issues in the codebase. To run ESLint and check for linting errors, use the following command:
npm run lintThis command will display linting warnings and errors in the terminal.
To preview the production build locally before deployment, use the following command:
npm run previewThis command will serve the production build locally, and you can access it in your browser at http://localhost:5143
This project uses the following tools: