Skip to content
Snippets Groups Projects
Commit 22de9012 authored by Piotr Kazala CSM2020's avatar Piotr Kazala CSM2020
Browse files

Update README.md

parent 1db40b66
No related branches found
No related tags found
No related merge requests found
To run the extension the following prerequisites need to be met: **To run the extension the following prerequisites need to be met:**
- Google Chrome installed on the device - Google Chrome installed on the device
- Node.js installed (for running tests and developer mode) - Node.js installed (for running tests and developer mode)
Adding the extension to the browser can be done by following these steps:
**Adding the extension to the browser can be done by following these steps:**
1. Download the zipped folder that includes a fully working build of the app as well as all of the extension’s code and assets. 1. Download the zipped folder that includes a fully working build of the app as well as all of the extension’s code and assets.
2. Head over to chrome://extensions and enable Developer mode by using a toggle in the top right corner of the screen. 2. Head over to chrome://extensions and enable Developer mode by using a toggle in the top right corner of the screen.
3. Click on "Load Unpacked" and navigate to the folder where downloaded the provided folder was unzipped. 3. Click on "Load Unpacked" and navigate to the folder where downloaded the provided folder was unzipped.
...@@ -9,13 +11,17 @@ Adding the extension to the browser can be done by following these steps: ...@@ -9,13 +11,17 @@ Adding the extension to the browser can be done by following these steps:
Now, the extension should be enabled in Google Chrome. Now, the extension should be enabled in Google Chrome.
To make using the extension simpler, it is recommended to pin it to the extension toolbar. To make using the extension simpler, it is recommended to pin it to the extension toolbar.
Instructions for running tests:
**Instructions for running tests:**
1. Ensure that Node.js is installed by running the command: node -v 1. Ensure that Node.js is installed by running the command: node -v
2. If it is not installed, do so by downloading it from this URL: https://nodejs.org/en/download 2. If it is not installed, do so by downloading it from this URL: https://nodejs.org/en/download
3. Navigate to the unzipped folder with the projects code and run this command to install all dependencies: npm install 3. Navigate to the unzipped folder with the projects code and run this command to install all dependencies: npm install
4. To run the tests run the following command: npx playwright test 4. To run the tests run the following command: npx playwright test
Instructions for running the project in development mode:
**Instructions for running the project in development mode:**
1. Ensure that Node.js is installed by running the command: node -v 1. Ensure that Node.js is installed by running the command: node -v
2. If it is not installed, do so by downloading it from this URL: https://nodejs.org/en/download 2. If it is not installed, do so by downloading it from this URL: https://nodejs.org/en/download
3. Navigate to the unzipped folder with the projects code and run this command to install all dependencies: npm install 3. Navigate to the unzipped folder with the projects code and run this command to install all dependencies: npm install
...@@ -23,5 +29,6 @@ Instructions for running the project in development mode: ...@@ -23,5 +29,6 @@ Instructions for running the project in development mode:
5. Click on "Load Unpacked" and navigate to the folder where downloaded the provided folder was unzipped. 5. Click on "Load Unpacked" and navigate to the folder where downloaded the provided folder was unzipped.
6. Navigate to the “build” directory, choose the chrome-mv3-dev folder and click select folder. 6. Navigate to the “build” directory, choose the chrome-mv3-dev folder and click select folder.
7. To run the development server use the following command: npm run dev 7. To run the development server use the following command: npm run dev
If any changes are made in development, a new production build can be generated by the following command: npm run build If any changes are made in development, a new production build can be generated by the following command: npm run build
This will generate a new chrome-mv3-prod directory which will hold the updated production build of the app. This will generate a new chrome-mv3-prod directory which will hold the updated production build of the app.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment