{"id":15809804,"url":"https://github.com/eddymens/coding-terms-build","last_synced_at":"2025-04-01T00:39:27.227Z","repository":{"id":163220235,"uuid":"397169797","full_name":"EDDYMENS/coding-terms-build","owner":"EDDYMENS","description":"Coding term definitions (build system). Markdown version here: https://github.com/EDDYMENS/coding-terms-markdown","archived":false,"fork":false,"pushed_at":"2022-07-15T12:13:37.000Z","size":404,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-10-06T03:41:19.671Z","etag":null,"topics":["build-tool","coding","coding-terms","definition"],"latest_commit_sha":null,"homepage":"https://codingterms.com","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/EDDYMENS.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2021-08-17T08:24:13.000Z","updated_at":"2022-01-19T07:20:38.000Z","dependencies_parsed_at":null,"dependency_job_id":"c5c33db5-19bd-4f36-b753-cc493739dd70","html_url":"https://github.com/EDDYMENS/coding-terms-build","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/EDDYMENS%2Fcoding-terms-build","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EDDYMENS%2Fcoding-terms-build/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EDDYMENS%2Fcoding-terms-build/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EDDYMENS%2Fcoding-terms-build/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/EDDYMENS","download_url":"https://codeload.github.com/EDDYMENS/coding-terms-build/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246563370,"owners_count":20797444,"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":["build-tool","coding","coding-terms","definition"],"created_at":"2024-10-05T03:41:16.045Z","updated_at":"2025-04-01T00:39:27.210Z","avatar_url":"https://github.com/EDDYMENS.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"## Coding Terms\n A project to define coding terms.\n \n This repo serves as the build system for both generating the [markdown](https://github.com/EDDYMENS/coding-terms-markdown) and [production site](https://github.com/EDDYMENS/coding-terms-site) for the project.\n\n\n ## Setting up the build system\n- Be sure to have [composer](https://getcomposer.org/download), [PHP ^7.3|^8.0](https://www.php.net)  installed.\n- Clone the [coding terms build repo](https://github.com/EDDYMENS/coding-terms-build). This one 🙂.\n- Run `composer install` to install all required dependencies.\n- To start the server run `php artisan serve`.\n\n ## Adding a new term\n\nYou will find all terms in the `/resources/views/markdown` folder. Each term definition is a markdown file.\n\nHere are a few things to note when adding new terms:\n- The term to be defined should be the name of the markdown file.\n - When naming files, use hyphens (-) to separate multi-word terms. Eg: `work-in-progress.md`.\n - use lower case when naming a file.\n - The content of the markdown file should have three parts a **definition**, use **case/example** and **summary**. The summary is, however, optional.\n\n In other to reference a term use the special helper `{{linkToPost('\u003creferenced_term\u003e')}}`. This will only convert to an href link if a corresponding markdown file is found. \n\nMeaning you can reference non-existing terms and define them later. \n\n To view referenced but yet to be defined term use the following steps: \n\n - Run `php artisan tinker`\n - Type out the function `undefinedLinks()` to view the list of undefined terms.\n\n ## Generating markdown\nThe source markdown files found in `/resources/views/markdown` may contain helper tags which might make reading them a bit difficult.\n\nRunning the command `php artisan markdown:generate \u003coutputPath\u003e` will parse all the markdown files and store them in the provided output path. \n\n[coding terms markdown repo.](https://github.com/EDDYMENS/coding-terms-markdown) stores an up-to-date copy of the parsed markdown files.\n\n ## Generating production site\nThere is a hosted version of the project at https://codingterms.com\n\nThe HTML files are generated using `WGET` and pushed to the [coding terms site repo](https://github.com/EDDYMENS/coding-terms-site).\n\nFollow these steps to generate an updated version of the HTML files whenever you make changes:\n\n- Be sure the build server is running `php artisan serve`\n- Clone the [coding terms site repo](https://github.com/EDDYMENS/coding-terms-site) repo.\n- Be sure you are outside the build repo.\n- Then run `WGET` to generate the HTML site. E.g.: Assuming the build is running on port 8000 `wget -mpEk -nH  -P \u003ccoding terms site repo\u003e http://localhost:8000`.\n- Open a pull request to merge your changes into the [coding terms site repo](https://github.com/EDDYMENS/coding-terms-site).","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feddymens%2Fcoding-terms-build","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Feddymens%2Fcoding-terms-build","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feddymens%2Fcoding-terms-build/lists"}