Last updated for 1.1, schema v4
- This is a content management system
- build.cjs and you
- Language support
- Localization
- Starting a new database
- Database schema
- Populating the database
- Import tool
- Stylistic choices
- Building the site
- License
- Contributing
- Developer Certificate of Origin
This project does not use a backend. Everything is compiled from one SQLite3 database into a fully static website. A build is invoked before starting the dev server or the production Vite build tool engages.
All of the content is compiled using the build.cjs tool and is stored inside a db file, by default - ./content.db.
build.cjs also includes a meriad of other features for managing the content database, such as importing bulk data.
To view available commands in build.cjs use:
$ node build.cjs help
Check your current database's version using:
$ node build.cjs version
The database is configured in a way that can store an infinite amount of languages. However, the frontend only supports rendering Lithuanian and English. See the localization guide below to add more languages.
Development tools and documentation is in en-150.
To add or complete language support for the frontend do the following:
First translate all the strings which are required to render the page. In the following example, we will make a Portuguese translation:
$ cp src/i18n/en.json src/i18n/pt.json
$ vim src/i18n/pt.json
In the front page a list of language flags are generated from the database, you will need to follow the example of public/img/ENyes.png and public/img/ENoff.png.
$ cp ~/PTyes.png public/img/
$ cp ~/PToff.png public/img/
Just insert it to the languages table:
insert into languages (language_code, display_name)
values ('pt', 'Portuguese');
When you clone the git repository, you will not have any content for the tests, you have to create a new database. Do it using the build.cjs tool.
$ node build.cjs new_db
First column is name of field, second is the type.
| key | text |
| value | text |
Two more values are expected to be made manually, key(default_language) and key(default_category).
A key(version) field is made automatically with the schema version.
| language_code | text |
| display_name | text |
| name | text |
| display_name | text |
| makeup | text |
| question_amount | integer |
makeup is a JSON object.
type CategoryMakeup = { [category: string]: number };For example, {"b": 30, "a": 5}' or {"b": 30}
| image_id | integer |
| image_name | text |
| image_data_uri | text |
| alt_text | integer |
| id | integer |
| image_id | integer key images/image_id |
| language | text |
| alt_text | text |
| id | integer |
| language | text |
| category | text |
| question_text | text |
| image_id | integer key images/image_id |
| relative_answers | integer |
| id | integer |
| question_id | integer key questions/id |
| answer_text | text |
| answer_order | integer |
| id | integer |
| question_id | integer key questions/id |
| answer_id | integer key possible_answers/id |
| answer_id_relative | integer |
You have to create your own content for your database. See the localisation guide.
For content, use the mass import tool.
To help importing new bulk content, you can use the import commands after arranging all files accordingly:
import/
alts.json
questions.json
img1.png
img2.jpg
[...]
build.cjs
alts.json is a file that holds all alt text information for the images. It follows this format:
[
{
"name": "img1.jpg",
"alt": {
"en": "First image",
[...]
}
},
[...]
]
questions.json is a file that holds all questions and answers to import. It follows this format:
[
{
// Language
"l": "en",
// Category
"c": "a",
// Question
"q": "...",
// Possible answers
"a": [
"...",
"..."
],
// Correct answers
"ca": [1, ...],
// Image file (optional)
// For questions without images, don't include this attribute
"i": "img1.jpg"
},
[...]
]
Then use this command to import the data:
$ node build.cjs import all
Website is built using build.cjs and Vite. The frontend is written using vanilla TypeScript, while build.cjs is written in vanilla Node JavaScript.
No framework for the frontend is used. Minimal dependencies.
The current npm scripts are added to build/test the site.
Start the development server:
$ npm run dev
Download a database file from the DATABASE_URL environment variable and build the site using Vite and build.cjs:
$ npm run build:prod
Build the site using build.cjs and Vite:
$ npm run build
Build the site using Vite:
$ npm run build:fast
Build the site using build.cjs and Vite, then start a preview server:
$ npm run serve
Format all files:
$ npm run fmt
Clean out all built files:
$ npm run clean
The project is licensed under MPL-2.0. Some of site's content is from State Enterprise Regitra, Font Awesome and Haiku. Depends on a couple of open source libraries: package.json
Old versions of Regitra Parody (before commit dbd479f on Sep 17, 2023) do not come with a license and therefore by default all rights are reserved. While I will not retroactively add a license to this code, I will not enforce any infringements made in good faith.
The official content database used in regitra.pages.dev is not shared and closed.
While the design is made to mimic the official State Enterprise Regitra's exam interface, this project was built from the ground up without using the code from the official interface.
This project has no affiliation with State Enterprise Regitra.
This project comes with no warranty and no support.
While the project is in a completed state, contributions may be considered. Development builds are seen in the next branch, with the subsequent domain next.regitra.pages.dev for the preview.
Your commits must be signed and signed-off.
By signing off you agree to the terms of the Developer Certificate of Origin as well as that your code could be used under a different license and will be used in the closed binary distribution found in regitra.pages.dev or any of its domains.
The content database is not shared and closed, any contributions must be done privately. You can find my contact here.
Developer Certificate of Origin
Version 1.1
Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.
Developer's Certificate of Origin 1.1
By making a contribution to this project, I certify that:
(a) The contribution was created in whole or in part by me and I
have the right to submit it under the open source license
indicated in the file; or
(b) The contribution is based upon previous work that, to the best
of my knowledge, is covered under an appropriate open source
license and I have the right under that license to submit that
work with modifications, whether created in whole or in part
by me, under the same open source license (unless I am
permitted to submit under a different license), as indicated
in the file; or
(c) The contribution was provided directly to me by some other
person who certified (a), (b) or (c) and I have not modified
it.
(d) I understand and agree that this project and the contribution
are public and that a record of the contribution (including all
personal information I submit with it, including my sign-off) is
maintained indefinitely and may be redistributed consistent with
this project or the open source license(s) involved.