{"id":13555028,"url":"https://github.com/evt-project/evt-viewer","last_synced_at":"2025-04-03T07:33:36.147Z","repository":{"id":23336713,"uuid":"26697147","full_name":"evt-project/evt-viewer","owner":"evt-project","description":"Edition Visualization Technology 2 - development","archived":false,"fork":false,"pushed_at":"2024-02-19T09:25:10.000Z","size":158625,"stargazers_count":74,"open_issues_count":54,"forks_count":17,"subscribers_count":16,"default_branch":"master","last_synced_at":"2024-02-19T10:42:01.784Z","etag":null,"topics":["angularjs","digital-edition","digital-humanities","evt","evt-viewer","tei-xml"],"latest_commit_sha":null,"homepage":"http://evt.labcd.unipi.it/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/evt-project.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2014-11-15T23:07:32.000Z","updated_at":"2024-04-15T19:02:12.848Z","dependencies_parsed_at":"2024-04-15T19:12:27.568Z","dependency_job_id":null,"html_url":"https://github.com/evt-project/evt-viewer","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/evt-project%2Fevt-viewer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/evt-project%2Fevt-viewer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/evt-project%2Fevt-viewer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/evt-project%2Fevt-viewer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/evt-project","download_url":"https://codeload.github.com/evt-project/evt-viewer/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246957241,"owners_count":20860592,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["angularjs","digital-edition","digital-humanities","evt","evt-viewer","tei-xml"],"created_at":"2024-08-01T12:03:00.161Z","updated_at":"2025-04-03T07:33:35.521Z","avatar_url":"https://github.com/evt-project.png","language":"JavaScript","funding_links":[],"categories":["JavaScript","others"],"sub_categories":[],"readme":"# EVT 2.0 (evt-viewer)\n[EVT (Edition Visualization Technology)](http://evt.labcd.unipi.it/) is a light-weight, open source tool specifically designed to create digital editions from texts encoded according to the [TEI XML schemas and Guidelines](http://www.tei-c.org/Guidelines/P5/), freeing the scholars from the burden of web programming and enabling the final users to browse, explore and study digital editions by means of a user-friendly interface.\n\nBelow you can find some instructions to install and configure the development framework for EVT 2.0 (evt-viewer).\nIf you need to know *how to use* an EVT Release please read `USER_README.md` instead.\n\n## Dev Environment Prerequisites\n\nYou need to preinstall NodeJS (see official documentation). \nEverything works properly with versions up to v10.19.0 (you can use `nvm` in order to have multiple versions of node installed in your device),\n\n## Starting the application\n1. Clone the repository from github\n    ```bash\n    git clone https://github.com/evt-project/evt-viewer.git\n    ```\n2. Move into `evt-viewer` folder\n    ```bash\n    cd evt-viewer\n    ```\n\n3. Install dependendencies and devDependencies\n    ```bash\n    npm install\n    npm install --only=dev\n    ```\n\n## Start EVT\n\nBefore starting EVT check if you have a *data* folder inside *app* where to put you XML file(s); otherwise create it. Then check if in the *app/config/config.json* the property *dataUrl* is pointing to your edition file. If you need, you can also change some of the other configuration parameters.\nIf you need information about the configuration file, please check the *README.md* within the *app* folder, or use the beta [EVT2-Config-Generator](http://evt.labcd.unipi.it/evt2-config/) to set your preferences and download a ready to use JSON file.\nYou can also use some ready-to-use xml files and configurations we've added to https://github.com/evt-project/evt-sample-documents (EVT2js folder).\n\nTo start EVT use\n``` bash\nnpm run start\n```\n\n### Every time you install a new package\nStop current process (*CTRL/CMD+C*) then:\n```bash\nnpm i\nnpm run start\n```\n\n### Every time you checkout to a different branch\nIf you need to work on a different branch, we recommend that you stop current process (*CTRL/CMD+C* in the bash terminal), repeat the steps of dependencies and devDependencie installations and launch again :\n```bash\nnpm i \nnpm run start\n```\n\n## Generate EVT Development Documentation\n\n[WIP]\n\n## Build a new EVT release\n``` bash\nnpm run build\n```\nor \n```bash\nnpm run build:prod\n```\nfor a minified version of the app.\n\nBoth scripts will create a *build* folder containing the built package.\nAdd a *data* folder with the XML files you need and open the index.html file to see your digital edition.\nNB: in this case, in order to make EVT work properly in a local environment, you need to use a browser that allows Cross origin requests.\n\n## Branch description\n\n### master\nThis is the main branch.\n\n### develop\nThis is the main development branch.\n\n### critical-edition\nBranch dedicated to the initial development of functionalities to support critical edition.\nThis is a closed branch.\n\n### dipl-mobile\nBranch dedicated to the development of support for mobile devices.\nThis is an abandoned branch.\n\n### BRANCHES USED FOR INTERNISHIPS\n#### feature/dipl-interp-edLevel\nBranch dedicated to the development of functionalities to support diplomatic and interpretative edition levels.\n\n#### feature/msDescription\nBranch dedicated to the development of functionalities to support manuscript description access.\n\n#### feature/place-names-map\nBranch dedicated to the development of functionalities to support an interactive map of places appearing in Named Entities Places List.\n\n#### feature/search\nBranch dedicated to the development of an internal Search Engine.\n\n#### feature/verses\nBranch dedicated to the development of the support of prose/verse visualization.\n\n#### feature/viewer-ITL\nBranch dedicated to the development of a new Image Viewer and the support for Image Text Linking feature.\n\n### STANBY FEATURE\n#### feature/3DHOP-support\nBranch dedicated to the test the integration of the tool 3DHOP.\nThis is a temporarily abandoned branch.\n\n### CLOSED FEATURE\n#### feature/bibliography\nBranch dedicated to the development of functionalities to support bibliography.\nThis is a closed branch.\n\n#### feature/critical-edition-2\nBranch dedicated to the development of functionalities to support critical edition.\nThis is a closed branch.\n\n#### feature/documentation\nBranch dedicated to the documentation management.\nThis is a closed branch.\n\n#### feature/localization\nBranch dedicated to the development of UI localization.\nThis is a closed branch.\n\n#### feature/named-entities\nBranch dedicated to the development of functionalities to support Named Entities.\nThis is a closed branch.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fevt-project%2Fevt-viewer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fevt-project%2Fevt-viewer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fevt-project%2Fevt-viewer/lists"}