{"id":21915533,"url":"https://github.com/feastframework/documentation","last_synced_at":"2026-05-05T04:31:39.512Z","repository":{"id":133001942,"uuid":"432615086","full_name":"FeastFramework/documentation","owner":"FeastFramework","description":"FEAST documentation and sample project","archived":false,"fork":false,"pushed_at":"2023-01-14T20:03:33.000Z","size":196,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-10-09T10:43:15.984Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"HTML","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/FeastFramework.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","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},"funding":{"github":"jpresutti"}},"created_at":"2021-11-28T04:07:52.000Z","updated_at":"2021-12-18T10:28:08.000Z","dependencies_parsed_at":"2023-06-29T04:06:54.049Z","dependency_job_id":null,"html_url":"https://github.com/FeastFramework/documentation","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/FeastFramework/documentation","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FeastFramework%2Fdocumentation","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FeastFramework%2Fdocumentation/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FeastFramework%2Fdocumentation/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FeastFramework%2Fdocumentation/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/FeastFramework","download_url":"https://codeload.github.com/FeastFramework/documentation/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FeastFramework%2Fdocumentation/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32635431,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-04T10:08:07.713Z","status":"online","status_checked_at":"2026-05-05T02:00:06.033Z","response_time":54,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":[],"created_at":"2024-11-28T19:12:39.810Z","updated_at":"2026-05-05T04:31:39.496Z","avatar_url":"https://github.com/FeastFramework.png","language":"HTML","funding_links":["https://github.com/sponsors/jpresutti"],"categories":[],"sub_categories":[],"readme":"![FEAST Framework](https://github.com/FeastFramework/framework/blob/master/logos/feast-transparent-small.png?raw=true)\n\n![PHP Version](https://img.shields.io/packagist/php-v/feast/feast/v3.x-dev)\n![License](https://img.shields.io/packagist/l/feast/feast.svg)\n[![Docs](https://img.shields.io/badge/docs-quickstart-green.svg)](https://docs.feast-framework.com)\n\nThis project is a sample project using FEAST Framework. In addition, it serves as the official repository\nfor [docs.feast-framework.com](https://docs.feast-framework.com). The project makes use of the MVC system of FEAST as\nwell as migrations. Additionally, an on-disk cache can be used to save database hits to the docs website.\n\n# Getting started\n\n### Github Personal access token\n\nA Github Personal access token is required to avoid rate limiting for fetching documentation. You can find the\ndocumentation [here](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)\n\nOnce you have generated a token (with no special permissions required), you are ready to configure the application.\n\n## Configuring the application\n\nIn order to use this project locally (which will allow you to self-host the docs), first\ncopy `configs/config.local.sample.php` to `configs/config.local.php` then override the values with the appropriate\nvalues.\n\nCreate a MySQL database with the same name as the config value of `database.default.name` and give access to\nthe `database.default.user`\n\n## Initializing the application\n\nFrom the root project of the folder run `php famine feast:migration:run-all` to initialize the database.\n\n## Fetching the doc info\n\n1. Fetch all releases with the following command `php famine release:generate`. This will download all release info from\n   Github and populate your database. To see what code this executes,\n   open `modules/CLI/Controllers/ReleaseController.php` and read `ReleaseController::generateGet`.\n\n2. Parse all markdown documentation. with the following command `php famine docs:parse`. This will use Github's api to\n   parse the markdown to HTML and save it to the database.\n\n## Speeding up the web application\n\nOnce you have set up either [Apache](https://docs.feast-framework.com/install.md#running-on-apache2)\nor [nginx](https://docs.feast-framework.com/install.md#running-on-nginx), the docs will function at whatever url you\nhave configured. Each request will run through generating routes, parsing configs, and fetching database info in\naddition to making queries when running. Through both FEAST's\nbuilt-in [caching](https://docs.feast-framework.com/cli.md#feastcache) and the Documentation projects cache, all of\nthese steps can be eliminated resulting in a (not very noticeably on most hosts) faster application!\n\nTo cache the routes, configs and dbinfo, run the following\ncommands: `php famine feast:cache:config-generate \u0026\u0026 php famine feast:cache:routing-generate \u0026\u0026 php famine feast:cache:dbinfo-generate`\n.\n\nTo cache the documentation application run `php famine cache:cache-all` or you can cache individual pieces.\nSee `php famine cache:cache` for more details.\n\n## Browsing the source\n\nThe following folders contain files that are used by the documentation application:\n\n1. `configs`\n2. `Controllers`\n3. `Mapper`\n4. `Migrations`\n5. `Model`\n6. `Modules/Cli/Controllers`\n7. `Views/Index`\n8. `Views/Partial`","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffeastframework%2Fdocumentation","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffeastframework%2Fdocumentation","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffeastframework%2Fdocumentation/lists"}