diff --git a/NOTICE b/NOTICE new file mode 100644 index 0000000..c3c88a4 --- /dev/null +++ b/NOTICE @@ -0,0 +1,20 @@ +NOTICE + +This software is originally authored by NetMan. + +If you modify this software or run it as a network service +(as defined by the GNU Affero General Public License v3), +you must do ALL of the following: + +1. Display the following attribution prominently in the user interface + of any interactive service: + + “Based on nuxt-prawo-jazdy by netman” + with a link to: https://git.mandarynki.eu/netman/nuxt-prawo-jazdy + +2. Retain this NOTICE file verbatim in all copies and derivatives. + +3. Include the same attribution in any documentation describing the service. + +This requirement is an additional term under AGPLv3 §7 and +is a condition of the license grant. diff --git a/README.md b/README.md index 1edd31a..f2655f5 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,38 @@ # nuxt-prawo-jazdy -## Required + + + -### db +Polish driver's license theoritical exam nuxt web app + +### What's it do? + +It mimicks the official Polish driver's license theoritical exam - has all categories from the database of questions from the Polish Ministry of Infrastructure (AM, A1, A2, A, B1, B, C1, C, D1, D, T, PT), which includes languages Polish, English, German and Ukrainian (not all questions provided by the Ministry are available in Ukrainian, so when using the Ukrainian version, you don't get such questions on the exam mimick). + +You can choose above options (category and language) and you're greeted with a replica of an official exam (20 basic questions, 12 advanced questions). Time for each basic question includes 20 seconds to get acquainted with the question, time for media to load, and 15 seconds for an answer. Time for each basic question includes 50 seconds for an answer. + +### My intent, inspiration and information about the project + +My intention is, to share access to test exams free of charge, you don't have to pay me - although you can, I greatly appreciate if you donate! + +I'm planning to host this project publicly and to put non-invasive ads if it gains enough traction + +All data used by this software is public information by definition provided in the Polish Constitution - [article 61.](https://www.sejm.gov.pl/prawo/konst/polski/kon1.htm), and can be acquired by either checking above links on the gov website, or by writing to the Ministry [(if something happened to be missing)](placeholder_for_post_about_missing_points_column) ==> (blog post to write in the future) + +This project is a website mimicking an official driver's license theoritical exam with a seperate media http server (not included here), connected using drizzle ORM to a SQLite database + +## Running + +### Required + +#### db A python script at [db-prawo-jazdy](https://git.mandarynki.eu/netman/db-prawo-jazdy) is designed to convert the CSV(s) to a SQLite database for use here. When you acquire your database via that script, insert it at your desired path (default `./db/database.db`) and change the `DATABASE_URL` environment value in `.env`. Visit [db-prawo-jazdy](https://git.mandarynki.eu/netman/db-prawo-jazdy) for more details. The database from November 2025 is included here at `./db/database.db` -### media +#### media A shell script at [media-prawo-jazdy](https://git.mandarynki.eu/netman/media-prawo-jazdy) for media files ([available on the website of the Ministry of Infrastructure](https://www.gov.pl/web/infrastruktura/prawo-jazdy) under the link title `Pytania egzaminacyjne na prawo jazdy`) will convert (copy) all `.wmv` files to `.mp4` and copy all `.jpeg` files to `.jpg`. When you have all media and the script completed successfully, host these files on a webserver of your choice (e.g. apache, nginx), and change the `CDN_URL` environment value in `.env` to your webserver URL including the folder path to the media files. Visit [media-prawo-jazdy](https://git.mandarynki.eu/netman/media-prawo-jazdy) for more details. @@ -34,16 +58,6 @@ A shell script at [media-prawo-jazdy](https://git.mandarynki.eu/netman/media-pra - [ ] clean up js code in exam.vue and result.vue (currently a little bit of a mess) - [ ] daisyui is stuck on 5.2.5 - newer versions break UI, reason unknown - consider moving to nuxtUI and another tailwind integration with nuxt than nuxtjs/tailwind -## Some information about the project - -My intention is, to share access to test exams free of charge, you don't have to pay me - although you can, I greatly appreciate if you donate! - -I'm planning to host this project publicly and to put non-invasive ads if it gains enough traction - -All data used by this software is public information by definition provided in the Polish Constitution - [article 61.](https://www.sejm.gov.pl/prawo/konst/polski/kon1.htm), and can be acquired by either checking above links on the gov website, or by writing to the Ministry [(if something happened to be missing)](placeholder_for_post_about_missing_points_column) ==> (blog post to write in the future) - -This project is a website mimicking an official driver's license theoritical exam (for all license categories provided by the Ministry: A, A1, A2, AM, B, B1, C, C1, D, D1, T, PT) with a seperate media http server (not included here), connected using drizzle ORM to a SQLite database - ## Setup Copy `.env.example` to `.env` and modify it to values specified in the `Required#db` and `Required#media` sections according to your case. @@ -78,7 +92,7 @@ pnpm preview Check out the [Nuxt documentation](https://nuxt.com/docs) for more information. -### [Licensing](./LICENSE) (AGPL-3.0-only) +## [Licensing](./LICENSE) (AGPL-3.0-only) ``` nuxt-prawo-jazdy: Polish driver's license theoritical exam nuxt web app @@ -97,3 +111,8 @@ GNU Affero General Public License for more details. You should have received a copy of the GNU Affero General Public License along with this program. If not, see . ``` + +This is important: + - Keep all existing copyright headers, [give credit](./NOTICE) + - Any modified versions or works based on this project must also be AGPLv3 + - Users interacting with this project over a network must have full access to the source code (including of forks, or modified versions) \ No newline at end of file