{"id":23299385,"url":"https://github.com/cyberlight/caninclude","last_synced_at":"2025-08-22T04:30:34.270Z","repository":{"id":40286518,"uuid":"259693109","full_name":"CyberLight/caninclude","owner":"CyberLight","description":"CAN I INCLUDE one TAG to ANOTHER? WHAT IS A QUESTION! Yorik (c) :)","archived":false,"fork":false,"pushed_at":"2023-03-04T22:00:27.000Z","size":2723,"stargazers_count":156,"open_issues_count":21,"forks_count":5,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-11-19T20:46:54.554Z","etag":null,"topics":["html","html-specification","html5","htmltag"],"latest_commit_sha":null,"homepage":"https://caninclude.glitch.me","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/CyberLight.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2020-04-28T16:32:10.000Z","updated_at":"2024-07-23T16:48:54.000Z","dependencies_parsed_at":"2024-01-13T16:23:08.775Z","dependency_job_id":"eea37a72-3ad9-440d-b720-98f8a29b9a3f","html_url":"https://github.com/CyberLight/caninclude","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/CyberLight%2Fcaninclude","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CyberLight%2Fcaninclude/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CyberLight%2Fcaninclude/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CyberLight%2Fcaninclude/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CyberLight","download_url":"https://codeload.github.com/CyberLight/caninclude/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":230554242,"owners_count":18244235,"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":["html","html-specification","html5","htmltag"],"created_at":"2024-12-20T08:17:05.244Z","updated_at":"2024-12-20T08:17:05.976Z","avatar_url":"https://github.com/CyberLight.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# CAN I INCLUDE\n\n\u003cdiv align=\"center\"\u003e\n    \u003cimg src=\"docs/images/logo.png\" width=\"260px\"/\u003e\n\u003c/div\u003e\n\nThis project provides functionality to test whether one tag can be included in another. Based on information from [HTML Spec WHATWG](https://html.spec.whatwg.org/)\n\n\u003cdiv align=\"center\"\u003e\n    \u003cimg src=\"docs/images/faces.png\" width=\"255px\"/\u003e\n\u003c/div\u003e\n\nPlease, see **Demo** [here](https://caninclude.glitch.me)\n\n\u003cdiv align=\"center\"\u003e\n    \u003cimg src=\"docs/images/app_main_screen.png\" width=\"560px\"/\u003e\n\u003c/div\u003e\n\n## Development environment\n* [VSCode](https://code.visualstudio.com/)\n* [VSCode Remote Containers](https://code.visualstudio.com/docs/remote/containers#_installation)\n* Clone `git clone https://github.com/CyberLight/caninclude`\n* Go to cloned project repo folder `cd caninclude`\n* Open in VSCode `code .`\n* In popup menu click by `Reopen in Container`\n* Whew!\n\n## Setup spec.json for app\n* `npm run crawl` - this command crawl html spec page and make json data for app\n\n## How to run app in development\n* `npm run dev` - this open app using **nodemon**\n* Go to url `http://localhost:3000` in your browser\n* That's all!\n\n### How to run app in production\n* Need to set env variables from [Environment variables](#environment-variables)  section\n* `npm start` - this command launch an app using **pm2** using **ecosystem.config.js**\n\n## Environment variables\n* `COOKIE_KEY` - a key for sign cookies `type: String`\n* `FEEDBACK_DAILY_LIMIT` - a limit count of feedbacks daily `type: Integer`\n* `RECOMMEND_CLEAR_CACHE_CRON_TIME` - string in [cron time format](https://github.com/kelektiv/node-cron#cron-ranges). Default value: `0 */30 * * * *` (every 30 minutes)\n* `MAIN_PAGE_DECORATION_TYPE` - main page decoration mode or type `type: String`, possible values: \n    * **NY_LIGHT_RIBBON**\n* `LOGO_URL` - URL of the logo file to be included in the src attribute of the img element\n* `LOGO_ALT` - text for alt attribute of img element\n\n## Project structure\n* **.data** - a folder for sqlite database\n* **.devcontainer** - a folder with VSCode Remote Containers configuration\n* **components** - a folder with server components that was written in **Preact**.\n* **scripts** - a folder with helper scripts for a project\n* **crawl.js** - a script for crawling html spec page\n* **ecosystem.config.js** - a configuration file for **pm2**\n* **nodemon.json** - a configuration file for **nodemon**\n* **server.js** - main and huge file which contains all routes and logic for an app\n* **specfix.js** - a script for making some additional json data transformations\n* **utils.js** - file with helper data managers and helper functions\n\n## Project routes that are important\n* `/` - Main page with some counters by usage of app and results for each tags\n* `/can/include?parent=\u0026child=` - renders page with full information and result of ability to include one tag into another\n* `/admin/feedbacks` - ui for manage and view feedbacks \n    * For ability to access to this route, you need:\n        * `npm run gen:invite role=admin`\n        * This script will output url like this: `/invites/81493f1f9a306f64417b91960f6ded3b/apply`\n        * Go to your browser and concatenate `http://localhost:3000` and `/invites/81493f1f9a306f64417b91960f6ded3b/apply` and press `Enter`\n        * After that you can access to `/admin/feedbacks`\n\n## License\nSee the [LICENSE](LICENSE.md) file for license rights and limitations (MIT).","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcyberlight%2Fcaninclude","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcyberlight%2Fcaninclude","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcyberlight%2Fcaninclude/lists"}