{"id":14971376,"url":"https://github.com/io-arc/io-arc","last_synced_at":"2025-07-08T13:13:13.125Z","repository":{"id":38301110,"uuid":"247561377","full_name":"io-arc/io-arc","owner":"io-arc","description":"It's so easy! build in 5 minutes! WEB/PWA/SPA boilerplate CLI.","archived":false,"fork":false,"pushed_at":"2023-06-02T17:18:44.000Z","size":2639,"stargazers_count":6,"open_issues_count":21,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-06-04T18:14:13.925Z","etag":null,"topics":["babel","browser-sync","cli","css","html","json","nodejs","pug","sass","stylus","typescript","webpack","workbox","yaml"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"isc","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/io-arc.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","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,"publiccode":null,"codemeta":null},"funding":{"github":["arcone-nk"]}},"created_at":"2020-03-15T22:19:19.000Z","updated_at":"2022-11-28T02:42:12.000Z","dependencies_parsed_at":"2024-08-19T16:17:03.211Z","dependency_job_id":"36797977-b139-45a3-9c95-a8e79ca618b1","html_url":"https://github.com/io-arc/io-arc","commit_stats":{"total_commits":404,"total_committers":5,"mean_commits":80.8,"dds":0.1188118811881188,"last_synced_commit":"519b6624c0e5517c375353e410c82ea9078686ca"},"previous_names":[],"tags_count":20,"template":false,"template_full_name":null,"purl":"pkg:github/io-arc/io-arc","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/io-arc%2Fio-arc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/io-arc%2Fio-arc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/io-arc%2Fio-arc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/io-arc%2Fio-arc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/io-arc","download_url":"https://codeload.github.com/io-arc/io-arc/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/io-arc%2Fio-arc/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260739046,"owners_count":23055074,"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":["babel","browser-sync","cli","css","html","json","nodejs","pug","sass","stylus","typescript","webpack","workbox","yaml"],"created_at":"2024-09-24T13:45:06.661Z","updated_at":"2025-07-08T13:13:13.101Z","avatar_url":"https://github.com/io-arc.png","language":"TypeScript","funding_links":["https://github.com/sponsors/arcone-nk"],"categories":[],"sub_categories":[],"readme":"# io arc\n\nIt's so easy! build in 5 minutes! WEB/PWA/SPA boilerplate CLI.\n\n\u003cdiv align=\"center\"\u003e\u003cimg src=\"images/logo.png\" width=\"150\" height=\"150\" alt=\"io arc -WEB/PWA/SPA boilerplate CLI-\"\u003e\u003c/div\u003e\n\n## Install\n\n```shell script\n$ npm i -g @io-arc/cli\n# or\n$ yarn global add @io-arc/cli\n```\n\n## Usage\n\n```shell script\n$ cd \u003cProject Directory\u003e\n$ io-arc\n```\n\n[Documents](https://io-arc.tech/) | [Set up configuration](https://io-arc.tech/configuration/) | [Builds](https://io-arc.tech/build/)\n\n## Select language and frameworks\n\n### HTML template engine\n\n- HTML (with handlebars)\n- Pug\n\nThe global constants that are available: [HTML (with handlebars)](tasks/task-webpack-html#features), [Pug](tasks/task-webpack-pug#features)\n\n### CSS language\n\n- CSS\n- SASS(SASS/SCSS)\n- Stylus\n\n### JS preprocessor\n\n- Babel\n- TypeScript\n\n#### JS framework\n\nAutomatically available in selected preprocessors.\n\n- Vue (Babel/TypeScript)\n\n## Local Server\n\n- [BrowserSync](https://browsersync.io/)\n\n## Other default use\n\n- File copy - ([documents](https://io-arc.tech/plugins/tasks/copy.html))\n- YAML to JSON file build - ([documents](https://io-arc.tech/plugins/tasks/yaml2json.html))\n- Build directory clean - ([documents](https://io-arc.tech/plugins/tasks/clean.html))\n- Stats for library used\n- Create manifest.json - ([documents](https://io-arc.tech/plugins/tasks/manifest.html))\n- Create Web Worker (Use [worker-loader](https://github.com/webpack-contrib/worker-loader)) - ([documents](https://io-arc.tech/build/js.html#web-worker))\n- Create Service Worker (Use [WorkBox](https://developers.google.com/web/tools/workbox/modules/workbox-build)) - ([documents](https://io-arc.tech/plugins/tasks/service-worker.html))\n- PNG/JPG/GIF to Webp files - ([documents](https://io-arc.tech/plugins/tasks/webp-converter.html))\n\n## Directory structure\n\nCreate directory structure below.\n\n```text\n\u003cProject Directory\u003e\n    ├ config/ (settings)\n    │   ├ default.yml (site settings)\n    │   ├ development.yml\n    │   ├ production.yml\n    │   ├ local.yml (build settings)\n    │   ├ local-development.yml\n    │   ├ local-production.yml\n    │   └ webpack.extends.js\n    ├ config-vue/ (select Vue only)\n    │   └ .pug-lintrc.json\n    ├ src/ (working directory)\n    │   ├ css/\n    │   ├ html/\n    │   ├ img/ (using file-loader)\n    │   ├ js/\n    │   ├ static/ (file copy)\n    │   └ yaml2json/\n    ├ types/ (select TypeScript only)\n    ├ .babelrc (select Babel only)\n    ├ .browserslistrc\n    ├ .editorconfig\n    ├ .eslintrc.yml\n    ├ .pug-lintrc.json (select Pug only)\n    ├ .gitignore\n    ├ .npmrc\n    ├ .prettierrc\n    ├ tsconfig.json (select TypeScript only)\n    ├ package.json\n    └ webpack.config.js\n```\n\n## Build options\n\nInternally, the build can be tweaked using the [node-config](https://github.com/lorenwest/node-config) library.\n\n### Site settings\n\nSettings related to the website, such as the site title, are specified in the `default.yml` or `development.yml` or `production.yml`.  \nSee example for [default.yml](packages/env/config/default.yml).\n\n[See documents](https://io-arc.tech/configuration/site.html).\n\n### Build settings\n\nThe build configuration is done in `local.yml`.  \nSee example for [local.yml](packages/env/config/local.yml).\n\n[See documents](https://io-arc.tech/configuration/build.html).\n\n## Extending the webpack build\n\nThere are several extensions available on the user side as well.  \nThe extension is configured in `\u003cproject\u003e/config/webpack.extends.js`.\n\nThe extensible webpack options are as follows.\n\n- [externals](https://webpack.js.org/configuration/externals/)\n- [module rule](https://webpack.js.org/configuration/module/#rule)\n- [plugins](https://webpack.js.org/configuration/plugins/)\n\nSee [example](example/config/webpack.extends.js).\n\n[See documents](https://io-arc.tech/configuration/webpack.html).\n\n## Using undefined [node-config](https://github.com/lorenwest/node-config) data on the client side\n\nIf you want to use global constants other than those available in TypeScript and Babel, you can use `CONFIG` global constants.\n\n```yaml\n# config/local-development.yml\napi: https://foo.com\n```\n\n```javascript\nconsole.log(CONFIG.api)\n// result =\u003e https://foo.com\n```\n\n\\* If you are using TypeScript, please define the type by yourself.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fio-arc%2Fio-arc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fio-arc%2Fio-arc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fio-arc%2Fio-arc/lists"}