{"id":21890926,"url":"https://github.com/statikbe/craft","last_synced_at":"2025-04-09T23:19:59.477Z","repository":{"id":38109343,"uuid":"203367280","full_name":"statikbe/craft","owner":"statikbe","description":"Craft CMS scaffolding package, for internal projects by Statik.be","archived":false,"fork":false,"pushed_at":"2025-04-09T16:44:21.000Z","size":11948,"stargazers_count":30,"open_issues_count":29,"forks_count":5,"subscribers_count":7,"default_branch":"develop","last_synced_at":"2025-04-09T17:46:46.663Z","etag":null,"topics":["craftcms","create-project","scaffolding","tailwindcss"],"latest_commit_sha":null,"homepage":"","language":"Twig","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/statikbe.png","metadata":{"files":{"readme":"README.MD","changelog":"CHANGELOG.MD","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-08-20T12:00:34.000Z","updated_at":"2025-04-04T07:08:42.000Z","dependencies_parsed_at":"2024-01-04T14:45:40.887Z","dependency_job_id":"9e260d31-5f2b-484a-a4ec-1327fa614c6c","html_url":"https://github.com/statikbe/craft","commit_stats":{"total_commits":889,"total_committers":17,"mean_commits":"52.294117647058826","dds":0.5118110236220472,"last_synced_commit":"8db99f3e01b912797d7ced67471cf74439b72014"},"previous_names":[],"tags_count":118,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/statikbe%2Fcraft","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/statikbe%2Fcraft/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/statikbe%2Fcraft/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/statikbe%2Fcraft/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/statikbe","download_url":"https://codeload.github.com/statikbe/craft/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248126037,"owners_count":21051858,"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":["craftcms","create-project","scaffolding","tailwindcss"],"created_at":"2024-11-28T12:18:18.419Z","updated_at":"2025-04-09T23:19:59.457Z","avatar_url":"https://github.com/statikbe.png","language":"Twig","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Craft CMS starter package by Statik.be\n\nThis a scaffolding package for Craft CMS, by [Statik.be](https://www.statik.be). We use this internally to start new projects.\n\n### Assumptions made\n\nWe assume a couple of things\n\n- We use [Ddev](https://ddev.com/) as our local development environment.\n\n- We use [Postmark](https://postmarkapp.com/) for email delivery.\n\n- We use [TailwindCSS](https://tailwindcss.com/) for our frontend build.\n\n---\n\n### 🛠 Usage\n\nBefore beginning make sure you have [Ddev](https://ddev.com/) installed and your docker-engine is running. Otherwise the install process will fail on initialization.\n\nUse the following command to set up a new project:\n\n```bash\n\ncomposer create-project statikbe/craft PATH\n\n```\n\n➡️ A Craft CMS project will be created. Next Craft asks to start the set-up:\n\n```bash\n   ______ .______          ___       _______ .___________.\n  /      ||   _  \\        /   \\     |   ____||           |\n |  ,----'|  |_)  |      /  ^  \\    |  |__   `---|  |----`\n |  |     |      /      /  /_\\  \\   |   __|      |  |\n |  `----.|  |\\  \\----./  _____  \\  |  |         |  |\n  \\______|| _| `._____/__/     \\__\\ |__|         |__|\n\n     A       N   E   W       I   N   S   T   A   L   L\n               ______ .___  ___.      _______.\n              /      ||   \\/   |     /       |\n             |  ,----'|  \\  /  |    |   (----`\n             |  |     |  |\\/|  |     \\   \\\n             |  `----.|  |  |  | .----)   |\n              \\______||__|  |__| |_______/\n\n\nGenerating an application ID ... done\nGenerating a security key ... done\n\nWelcome to Craft CMS!\n\nAre you ready to begin the setup? (yes|no) [yes]\n```\n\n➡️ The next questions will be asked:\n\n- Which database driver are you using? (mysql or pgsql)\n- Database server name or IP address [127.0.0.1]\n- Database port [3306]\n- Database username [root]\n- Database password\n- Database name\n- Database table prefix\n\n➡️ Using the above defaults suggested by craft, will allow you to connect to your Ddev database and the installation will continue.\n\n- Install Craft now? [yes]\n- Email\n- Password\n- Confirm\n- Site name [NL]\n- Site URL [@baseUrl/nl]\n- Site language [nl-BE]\n\n➡️ Craft is installed, the plugins are installed and the existing project config is applied! 🚀\n\nNow we're ready to initiate the Statik set-up:\n\n```bash\n\ncd PATH\n\nddev craft statik/setup\n\n```\n\n➡️ This will give you the following options/ask you the following questions:\n\n```bash\n       _______.___________.    ___   .___________.__   __  ___\n        /       |           |   /   \\  |           |  | |  |/  /\n       |   (----`---|  |----`  /  ^  \\ `---|  |----|  | |  '  /\n        \\   \\       |  |      /  /_\\  \\    |  |    |  | |    \u003c\n    .----)   |      |  |     /  _____  \\   |  |    |  | |  .  \\\n    |_______/       |__|    /__/     \\__\\  |__|    |__| |__|\\__\\\n\n       A     N  E  W     C  R  A  F  T     P  R  O  J  E  C  T\n\n```\n\n- Enter a new system name\n- Do you want to remove the frontend account flow in Craft?\n\nIf you continue the next sections will be removed: _confirmAccount, editPassword, editProfile, forgotPassword, forgotPasswordConfirmation, login, profile, register, registrationCompleted, setPassword, setPasswordConfirmation_\n\n- Do you want to use [Postmark](https://account.postmarkapp.com/servers) for email transport? (yes|no)\n  - Enter a Postmark API key\n- Enter an emailaddress to use for testing on staging environments\n- Do you want to set up a [git repo](https://statik.beanstalkapp.com/) for this project? (yes|no)\n  - Add a remote?\n- Do you want to initialize [git-flow](https://nvie.com/posts/a-successful-git-branching-model/)? (yes|no)\n\n➡️ The installation is ready!\n\n---\n\n### 🎨 Frontend Setup\n\nWe use tailwindscss and vite.js\n\n- `vite.config.js`\n- `tailwind.config.js`\n\nGetting started\n\n```bash\n\n[optional] nvm install\nyarn install\n\n```\n\nAfterwards you can build using\n\n```bash\n\nyarn dev\n\n```\n\nor\n\n```bash\n\nyarn watch\n\n```\n\n**CSS and Javascript**\n\n`tailoff/css` and `tailoff/js`\n\n**Favicon**\nAdd an svg in `tailoff/img/` called `favicon.svg` and run\n\n```bash\n\nyarn favicon\n\n```\n\n**Icons**\nIcon go in the folder `tailoff/icons`\n\n---\n\n### 🧪 Testing\n\nThere are two tests added to the frontend stack.\nAn A11y tester that uses pa11y-ci under the hood.\nAnd a html tester that we wrote ourself, inspired by the pa11y code, that uses html-validate under the hood.\nYou can call them by using these commands:\n\n```\n$ yarn test-a11y\n$ yarn test-html\n```\n\nThey both use the BASE_URL variable from the .env file to get the craft sitemap. This sitemap gets parsed to get a list of all url's in the site. And the tests are then performed on these URL's.\n\n**Attention**\nTo get the tester running on your local system. Run the following command in your terminal\n\n```\nexport NODE_EXTRA_CA_CERTS=\"$(mkcert -CAROOT)/rootCA.pem\"\n```\n\n### ⚙️ Development\n\nTo work on this repo you can clone it like you would a regular project:\n\n```\n\ngit clone git@github.com:statikbe/craft.git craft\n\n```\n\n---\n\n### ⭐️ Features \u0026 support\n\nWe'd love the hear your suggestions and review your pull requests, but keep in mind that is repo is for internal projects first.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstatikbe%2Fcraft","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstatikbe%2Fcraft","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstatikbe%2Fcraft/lists"}