{"id":25040688,"url":"https://github.com/stefansarya/scarletsframe-default","last_synced_at":"2025-04-13T23:22:18.393Z","repository":{"id":40774143,"uuid":"213271753","full_name":"StefansArya/scarletsframe-default","owner":"StefansArya","description":"Basic template for ScarletsFrame","archived":false,"fork":false,"pushed_at":"2024-12-09T18:49:35.000Z","size":146,"stargazers_count":7,"open_issues_count":0,"forks_count":3,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-12T12:56:17.443Z","etag":null,"topics":["scarletsframe"],"latest_commit_sha":null,"homepage":"","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/StefansArya.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,"publiccode":null,"codemeta":null}},"created_at":"2019-10-07T01:23:58.000Z","updated_at":"2024-10-23T17:27:02.000Z","dependencies_parsed_at":"2024-10-23T20:04:58.678Z","dependency_job_id":"61aff182-ae94-426a-ab1a-e871a313d852","html_url":"https://github.com/StefansArya/scarletsframe-default","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/StefansArya%2Fscarletsframe-default","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/StefansArya%2Fscarletsframe-default/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/StefansArya%2Fscarletsframe-default/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/StefansArya%2Fscarletsframe-default/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/StefansArya","download_url":"https://codeload.github.com/StefansArya/scarletsframe-default/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248795163,"owners_count":21162722,"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":["scarletsframe"],"created_at":"2025-02-06T03:09:24.436Z","updated_at":"2025-04-13T23:22:18.371Z","avatar_url":"https://github.com/StefansArya.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ScarletsFrame's default template\nBasic template for scarletsframe.\nIf something is not working, feel free to create new issue.\n\nLet's begin with these steps\n\n### Install dependency\nWe will use [scarletsframe-compiler](https://github.com/StefansArya/scarletsframe-compiler), but it's still work in progress. You can use another custom build chain like using [Webpack](https://github.com/krausest/js-framework-benchmark/tree/master/frameworks/keyed/scarletsframe)/Rollup/Parcel.\n\n```sh\n$ npm i\n```\n\n## Starting the development server\n```sh\n$ npm start\n\n# Or use gulp if already installed globally\n$ gulp\n```\n\n### Compile or build the project\nThe compilation process will minify your code and also run Babel transpiler to support low end browser.\n```sh\n# Compile the template\n$ npm run compile\n\n# Or use gulp\n$ gulp compile\n```\n\n### Modifying the code\nThe `/public` folder is the directory where the browser could access every content inside of it. `index.html` is the default html file that being served after the server was started.\n\n### Hot Reload\nEverytime you modify the project's source code inside `/src` folder the development server will reload the browser. The compiler already have versioning, so you don't need to press CTRL+F5 every time you modify your code in `/src`.\n\nIf you want to change the hot reload behaviour you can modify it from `/public/index.html`.\n\n### Frame Inspector Tools\nTo open this interface make sure you're using the framework in development mode and have called `sf.hotReload`. After you saw `Development Mode Enabled` on the left side of the browser's window you can press `Ctrl + Alt + MouseMove` and hover to any element, then click it to lock the inspector tools.\n\n![chrome_8ja0xmlrPM](https://user-images.githubusercontent.com/11073373/107117810-6485fc00-68af-11eb-8634-9e07786fa13a.png)\n\n### Compiler settings\nYou can modify some parameter on the `/gulpfile.js` if you want to have different configuration.\n\n### ScarletsFrame file extension\nBefore you getting started with `.sf` file, please install the syntax highlighter from this [link](https://github.com/StefansArya/scarletsframe-compiler/tree/master/syntax-highlighter/vscode). There are an example in the `/src/vw-myview/example.sf`.\n\n## GitHub Pages\nThere are a default template for deploying into `gh-pages` branch on `/.github/workflows/gh-pages.yml-template`. To use it you just need to rename it to `gh-pages.yml`. Then go to your project settings, scroll down, and configure your GitHub Pages.\n\n### For automatic build on Vercel\nIf you're using Vercel you can specify this on the settings.\u003cbr\u003e\n\u003e Build Command       : npm run compile\u003cbr\u003e\n\u003e Output Directory    : public\u003cbr\u003e\n\u003e Development Command : npm start\u003cbr\u003e\n\n`Build command` is a command for compiling the source and the compiled files will be placed on public folder (configured on `gulpfile.js`). `Development Command` is a command for starting the compiler server so you can use hot reload feature if you editing the source somewhere.\n\n### License\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstefansarya%2Fscarletsframe-default","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstefansarya%2Fscarletsframe-default","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstefansarya%2Fscarletsframe-default/lists"}