diff --git a/NOTE.md b/NOTE.md deleted file mode 100644 index adf3731..0000000 --- a/NOTE.md +++ /dev/null @@ -1,18 +0,0 @@ -Dati: -- credenziali unto -- id libro (da url) - -Background: -http://unito.studenti33.it/secure/docs/9780323299565/HTML//files/assets/common/page-vectorlayers/0315.svg?uni=557d76170c245168845e5673708d98fd - -Testo: -https://unito.studenti33.it/secure/docs/9780323299565/HTML//files/assets/common/page-html5-substrates/page0315_1.jpg?uni=557d76170c245168845e5673708d98fd - -Pagina libro generica (vista utente): -http://unito.studenti33.it/secure/docs/9780323299565/HTML/312/index.html - -URL generica: -https://idp.unito.it/idp/profile/SAML2/Redirect/SSO?execution=e1s2 - -While req != 404: - fetch quelle due url in base a ID \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..8867ad8 --- /dev/null +++ b/README.md @@ -0,0 +1,82 @@ +# UniTO book scrape +_English version [below](#unito-book-scrape-english)._ + +UniTO-book-scrape è un'applicazione pensata per semplificare l'uso della biblioteca virtuale dell'Università di Torino (UniTO). 📚 + +L'applicazione è in grado di scaricare un libro, salvandolo in un comodo documento PDF. 📄 + +## Vantaggi +- Seleziona e cerca nel testo 🔎 +- Effettua il login una volta sola 🔓 +- Portabilità 🛩 + +A differenza della biblioteca virtuale, i PDF generati da quest'app dispongono di testo selezionabile! + +Una volta effettuato il login e generato un PDF non sarà più necessario connettersi alla rete o inserire credenziali! + + +## Esecuzione +[Accedere](https://github.com/ornato-t/UniTO-book-scrape/releases) all'ultima versione dell'app utilizzando la barra sulla destra (Releases). Da lì sarà possibile scaricare un archivio compresso contenente un eseguibile (.exe). + +In alternativa, è possibile utilizzare NodeJS per eseguire gli script localmente. + +```bash +npm i +``` +per installare le dipendenze +```bash +npm start +``` +per compilare `index.ts` ed eseguire il risultante file `index.js`. + +È possibile compilare tale script in un file binario tramite +```bash +npm run build +``` + +## Disclaimer +Lo sviluppatore non ha modo di controllare l'uso che viene fatto dei PDF generati; pertanto ogni responsabilità è a carico degli utenti. + +L'uso dell'app e dei PDF generati **DEVE** essere limitato a studenti regolarmente immatricolati presso UniTO e con diritto di accedere alla biblioteca virtuale. + +Ogni eventuale violazione di copyright è a carico degli utenti. + +# UniTO book scrape (English) + +UniTO-book-scrape is an application meant to simplify the use of the Università di Torino (UniTO) virtual library. 📚 + +The application is able to download a book, saving it in a convenient PDF document. 📄 + +## Advantages +- Select and search through text 🔎 +- Log in only once 🔓 +- Documents are portable 🛩 + +Unlike the virtual library, PDFs generated by this app feature selectable and searchable text! + +Once a PDF is generated, users won't have to connect to the Internet or log in to view it! + +## Execution +[Access](https://github.com/ornato-t/UniTO-book-scrape/releases) to the latest version of the app by using the sidebar on the right (Releases). From there, download the zipped archive containing the executable file (.exe). + +Alternatively, users may also run the scripts locally via NodeJS. +```bash +npm i +``` +to install all dependencies +```bash +npm start +``` +to compile `index.ts` and run the resulting `index.js` file. + +It is also possible to compile said file into a binary (.exe) via +```bash +npm run build +``` + +## Disclaimer +The developer has no way of keeping track of how the generated PDF are used, therefore all responsibilities fall onto the users. + +The usage of the app and the generated PDFs **MUST** be limited to regularly enrolled UniTO students, with right to access the virtual library. + +Any and all copyright violations fall onto the user. \ No newline at end of file diff --git a/package-lock.json b/package-lock.json index df1e434..b22c140 100644 --- a/package-lock.json +++ b/package-lock.json @@ -14,7 +14,8 @@ }, "devDependencies": { "esbuild": "0.17.11", - "nexe": "^4.0.0-rc.2" + "nexe": "^4.0.0-rc.2", + "typescript": "^4.9.5" } }, "node_modules/@babel/code-frame": { @@ -3008,6 +3009,19 @@ "node": "*" } }, + "node_modules/typescript": { + "version": "4.9.5", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-4.9.5.tgz", + "integrity": "sha512-1FXk9E2Hm+QzZQ7z+McJiHL4NW1F2EzMu9Nq9i3zAaGqibafqYwCVU6WyWAuyQRRzOlxou8xZSyXLEN8oKj24g==", + "devOptional": true, + "bin": { + "tsc": "bin/tsc", + "tsserver": "bin/tsserver" + }, + "engines": { + "node": ">=4.2.0" + } + }, "node_modules/unbzip2-stream": { "version": "1.4.3", "resolved": "https://registry.npmjs.org/unbzip2-stream/-/unbzip2-stream-1.4.3.tgz", @@ -5280,6 +5294,12 @@ "safe-buffer": "^5.0.1" } }, + "typescript": { + "version": "4.9.5", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-4.9.5.tgz", + "integrity": "sha512-1FXk9E2Hm+QzZQ7z+McJiHL4NW1F2EzMu9Nq9i3zAaGqibafqYwCVU6WyWAuyQRRzOlxou8xZSyXLEN8oKj24g==", + "devOptional": true + }, "unbzip2-stream": { "version": "1.4.3", "resolved": "https://registry.npmjs.org/unbzip2-stream/-/unbzip2-stream-1.4.3.tgz", diff --git a/package.json b/package.json index bb4a89b..aad61e0 100644 --- a/package.json +++ b/package.json @@ -23,7 +23,8 @@ }, "devDependencies": { "esbuild": "0.17.11", - "nexe": "^4.0.0-rc.2" + "nexe": "^4.0.0-rc.2", + "typescript": "^4.9.5" }, "type": "module" }