{"id":19776897,"url":"https://github.com/neoground/charm-wireframe","last_synced_at":"2025-07-08T11:39:52.518Z","repository":{"id":49233469,"uuid":"142490726","full_name":"neoground/charm-wireframe","owner":"neoground","description":"Jumpstart Charm projects with Charm-Wireframe, a feature-packed boilerplate for seamless web app \u0026 API development. Get started quickly!","archived":false,"fork":false,"pushed_at":"2025-02-24T21:36:35.000Z","size":186,"stargazers_count":1,"open_issues_count":10,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-02-24T22:30:42.257Z","etag":null,"topics":["boilerplate","charm-framework","wireframe"],"latest_commit_sha":null,"homepage":"","language":"PHP","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/neoground.png","metadata":{"files":{"readme":"README-project.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,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-07-26T20:26:47.000Z","updated_at":"2025-02-24T21:36:32.000Z","dependencies_parsed_at":"2024-03-01T15:25:37.043Z","dependency_job_id":"1e3aaf6d-4a81-472a-916c-1eb4eb72fd87","html_url":"https://github.com/neoground/charm-wireframe","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/neoground%2Fcharm-wireframe","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/neoground%2Fcharm-wireframe/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/neoground%2Fcharm-wireframe/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/neoground%2Fcharm-wireframe/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/neoground","download_url":"https://codeload.github.com/neoground/charm-wireframe/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241107358,"owners_count":19910973,"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":["boilerplate","charm-framework","wireframe"],"created_at":"2024-11-12T05:22:16.141Z","updated_at":"2025-02-28T05:44:59.526Z","avatar_url":"https://github.com/neoground.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# PROJNAME\n\n## Getting Started with this Charm-based Project\n\nWelcome to the PROJNAME built upon the powerful Charm framework! \nSetting up the project is a breeze, and you'll be up and running in no time.\nJust follow these simple steps, and you'll be coding with the Force on your side. 🚀\n\n1. Clone the repository: Clone the PROJNAME's repo to a new folder on your local machine.\n   ```bash\n   git clone https://github.com/youruser/PROJNAME.git /path/to/PROJNAME\n   cd /path/to/PROJNAME\n   ```\n2. Install dependencies: Run `composer install` to fetch all required dependencies.\n   ```bash\n   composer install\n   ```\n3. Create necessary directories: Ensure the var/cache, var/logs, and data directories are in place.\n   ```bash\n   mkdir -p var/cache var/logs data\n   ```\n4. Set permissions: If your web server runs as a different user, grant read, write, and execute permissions to the directories.\n   ```bash\n   chmod -R 0777 var/cache var/logs data\n   ```\n5. Create local environment: Execute bob c:env Local, and the trusty assistant will create a local environment for you.\n   ```bash\n   bob c:env Local\n   ```\n6. Depending on your project's setup you should now run any initial commands, like for migrating the database:\n   ```bash\n   bob db:sync\n   ```\n7. Install additionally needed packages depending on your project, like `npm install` for your node assets\n8. Configure web server: Update your Apache or Nginx configuration to handle rewrites to the `index.php` file.\n   For apache2 you can find a `.htaccess` and for nginx a `nginx.conf` file in this repository.\n9. If your project uses cron or the queue, make sure the commands are executed regularly, like `bob cron:run`.\n   It is recommended to run the cron / queue daemon on linux hosts, but you can also use a classic systemd service\n   or crontab. See `var/Services` for examples, including Initrc + OpenRC. You can also easily create a default\n   systemd service for the cron daemon via `bob cron:info systemd`.\n10. Open the new project in your browser or run a development server with `bob serve`.\n\nFor more information on setting up a charm project, see the [Charm Installation Guide](https://neoground.com/docs/charm/start.installation).\n\nYou can learn more about the Bob CLI tool in the [Bob Documentation](https://github.com/neoground/charm-toolkit).\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fneoground%2Fcharm-wireframe","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fneoground%2Fcharm-wireframe","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fneoground%2Fcharm-wireframe/lists"}