1
0
mirror of https://github.com/chylex/Firefox-SCsCC.git synced 2025-05-13 12:34:04 +02:00

add development information

This commit is contained in:
sarics 2019-07-22 19:36:20 +02:00
parent 7a0fb288d1
commit c6998e6b44

View File

@ -3,3 +3,46 @@
Currency Converter for Firefox
https://addons.mozilla.org/firefox/addon/scscurrencyconverter/
## Development
Requirements:
- [Node.js](https://nodejs.org/)
- [npm](https://github.com/npm/cli/releases/latest)
### Install
To install the project's dependencies:
```sh
npm install
```
### Start
During development use:
```sh
npm start
```
This will build a develpment version of the scripts in the dist folder, and starts webpack in watch mode.
In an other terminal/console:
```sh
npm run run:web-ext
```
This opens a clean Firefox with the addon installed. Every time a script is modified, the addon will be reloaded.
### Build
To build the addon, use:
```sh
npm run build
```
This will build a production version of the scripts in the dist folder, and packages them into a zip file in the build folder.