{"id":21893705,"url":"https://github.com/asterics/asterics-solution-template","last_synced_at":"2025-10-23T21:33:12.540Z","repository":{"id":45380668,"uuid":"116941094","full_name":"asterics/asterics-solution-template","owner":"asterics","description":"This repository contains a template project structure for an AsTeRICS based solution using the AsTeRICS Packaging Environment (APE).","archived":false,"fork":false,"pushed_at":"2021-12-16T16:42:07.000Z","size":320,"stargazers_count":0,"open_issues_count":1,"forks_count":1,"subscribers_count":9,"default_branch":"master","last_synced_at":"2025-02-03T02:53:44.774Z","etag":null,"topics":["accessibility","ape","assistive-technology","demo","example","template","template-project"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/asterics.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-01-10T10:13:14.000Z","updated_at":"2021-12-16T16:42:11.000Z","dependencies_parsed_at":"2022-09-06T17:30:42.734Z","dependency_job_id":null,"html_url":"https://github.com/asterics/asterics-solution-template","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/asterics%2Fasterics-solution-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/asterics%2Fasterics-solution-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/asterics%2Fasterics-solution-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/asterics%2Fasterics-solution-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/asterics","download_url":"https://codeload.github.com/asterics/asterics-solution-template/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244902918,"owners_count":20529114,"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":["accessibility","ape","assistive-technology","demo","example","template","template-project"],"created_at":"2024-11-28T13:16:13.318Z","updated_at":"2025-10-23T21:33:12.471Z","avatar_url":"https://github.com/asterics.png","language":"JavaScript","readme":"# AsTeRICS based AT solution\n\nThis folder contains an AsTeRICS based solution using the [APE (AsTeRICS Packaging Environment)](https://github.com/asterics/AsTeRICS/wiki/AsTeRICS-Packaging-Environment-(APE)) template folder structure.\n\n# Prerequisites\n\nPlease follow the instructions of this [tutorial](https://github.com/asterics/AsTeRICS/wiki/AsTeRICS-Solution-Template-Repository#prerequisites)\n\n# Demos / Examples\n\nYou can try some (other) [demos](http://asterics.github.io/AsTeRICS/demos.html) and [asterics solution example repositories](https://github.com/asterics?utf8=%E2%9C%93\u0026q=topic%3Aexample\u0026type=\u0026language=) here.\n\n# Run project\n\nEnter\n\n```ant run```\n\nto build all the dependencies and start the ARE.\n\nYou can also start the ARE using the ARE start-scripts in the ```build/merged/bin/ARE``` folder.\n\n# Folder structure\nSubsequently you can see the simplified folder structure of an APE-based project, which contains an ant build file (**```build.xml```**), a property-based configuration file (**```APE.properties```**), the **```custom/bin/ARE```** folder to store the solution-specific files (e.g. model files), a **```build```** folder and a **```package```** folder for native installer customization. \n\n```\nbuild\n  |- merged\n  |- deploy\ncustom\n  |- bin/ARE\n    |- data\n    |- images\n    |- LICENSE\n    |- models\n      |- \u003ccustom model file\u003e.acs\n      |- ...\n    |-profile\n    |- web\n      |- webapps\n        |- startpage\n          |- start.html\n        |- \u003cyour webapps folder\u003e\n          |- index.html\npackage\n  |- linux\n  |- windows\n  |- macosx\nAPE.properties\nbuild.xml\n```\n\n# How to use the repository\n\nFirst, please read the tutorial about the [**AsTeRICS Solution Template Repository**](https://github.com/asterics/AsTeRICS/wiki/AsTeRICS-Solution-Template-Repository).\n\n## Quick howto\nPut all your custom files (model files, images, config files,...) to the [custom/bin/ARE](custom/bin/ARE) folder. \n\nIn case you have a web UI put the files (.html, images, .css, .js,...) to the document root [(custom/bin/ARE/web)](custom/bin/ARE/web) of the built-in webserver. The webserver also provides a [websocket](https://github.com/asterics/AsTeRICS/wiki/AsTeRICS-Websocket). Finally the ARE provides a [REST API](https://github.com/asterics/AsTeRICS/wiki/AsTeRICS-REST-API) that can be used within a web application.\n\nBefore the project can be run it must be [built](#build-project) (builds the AsTeRICS repository and copies/merges needed plugin jars and project files to the ```build/merged/bin/ARE``` folder). You can also directly [run](#run-project) the ARE with the project's solution.\n\n# Recommended workflow\n\n1. Save custom files (models, images, config files,...) to the custom/bin/ARE folder or subfolders (e.g. web/...) or modify them\n2. Call ```ant APE-copy \u0026 ant run-quick```\n3. This should automatically open [http://localhost:8081](http://localhost:8081) in your standard browser.\n4. If you want to modify the running model, press 'F8' to open it in the WebACS, then modify and upload it. To save successful modifications permanently, save the model file to the ```custom/bin/ARE/models``` folder again.\n5. Kill program and go to step 1\n\n# Release project\n\nTo create a native installer open a console and run\n\n```ant deploy```\n\nPlease also check additional [dependencies](https://github.com/asterics/AsTeRICS/tree/master/bin/APE#dependencies) and [usage examples](https://github.com/asterics/AsTeRICS/tree/master/bin/APE#example-usages-of-the-build-infrastructure). \n\n# Other ant targets\n\nTo see all supported targets, call\n\n```ant -projecthelp```\n\n# Changing AsTeRICS snapshot (ARE) used\n\nThe property ```ARE.baseURI``` defines the location of the ARE used for the execution of the project. \n\nAPE automatically searches for an ARE at the following locations:\n1. ```dependencies/AsTeRICS/bin/ARE``` (if Asterics is added as submodule)\n2. ```../AsTeRICS/bin/ARE``` (if it's an APE projectdir withouth FABI and FLipMouse folder structure)\n3. ```../../AsTeRICS/bin/ARE``` (if it's an AT solution folder structure)\n4. ```C:/Program Files (x86)/AsTeRICS/ARE/``` (if there is an Asterics installation on windows)\n\nYou can also set ARE.baseURI manually, either in the file ```APE.properties``` or within an ant call, e.g. \n\n```ant -DARE.baseURI=\u003cpath to ARE\u003e run```\n  \n```ant -DARE.baseURI=D:/AsTeRICS/AsTeRICS/bin/ARE/ run```\n \n# License\n\nDual license MIT or GPLv3 with CLASSPATH exception. Please read more in the [license section](https://github.com/asterics/AsTeRICS/wiki/Licensing) of the wiki.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fasterics%2Fasterics-solution-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fasterics%2Fasterics-solution-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fasterics%2Fasterics-solution-template/lists"}