Skip to content

Latest commit

 

History

History
30 lines (25 loc) · 1.94 KB

README.md

File metadata and controls

30 lines (25 loc) · 1.94 KB

About

This repository hosts the source code of the "Ricerca su Treccani" Firefox extension, which lets you search the Treccani online corpus directly from the browser address bar.

Building the extension from source

Source code built on Windows 10 Home Edition, version 22H2 (build 19045.3930), using the following tools:

  • Node.js version 20.11.1;
  • npm version 10.2.4;
  • TypeScript version 5.4.2;
  • @types/firefox-webext-browser package version 120.0.2.

You should be able to build the project on other platforms and with different versions, too. However, TypeScript 3.7 or higher is required as optional property access (?.) and nullish coalescing (??) operators are used.

Prerequisites

To build this project, you first need to download and install Node.js (which includes npm), TypeScript and optionally Git. For more information on how to install these tools, please see the links above.

Get the code

Download this repository or clone it with Git: git clone https://github.com/giuse94/TreccaniSearch.git. If you opted for the download, unzip the folder (extract its content) in a folder of your choice.

Build the project

Open your favourite terminal and set the ts folder (which you find inside the folder you created in the previous step) as your working directory. Download and install this package via npm: npm install @types/firefox-webext-browser. Now you can build the project by simply running tsc. As a result, the package folder will be filled with the JavaScript files you need to run the extension in your browser.