{"id":26278751,"url":"https://github.com/textpattern/textpattern-forum","last_synced_at":"2025-07-27T07:35:04.974Z","repository":{"id":802538,"uuid":"13170825","full_name":"textpattern/textpattern-forum","owner":"textpattern","description":"Official forum of the Textpattern project.","archived":false,"fork":false,"pushed_at":"2024-10-24T08:22:21.000Z","size":4064,"stargazers_count":13,"open_issues_count":3,"forks_count":3,"subscribers_count":6,"default_branch":"main","last_synced_at":"2024-10-29T14:54:35.827Z","etag":null,"topics":["fluxbb","forum","theme"],"latest_commit_sha":null,"homepage":"https://forum.textpattern.com","language":"SCSS","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/textpattern.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":".github/CODE_OF_CONDUCT.md","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":"2013-09-28T10:03:29.000Z","updated_at":"2024-10-24T08:22:18.000Z","dependencies_parsed_at":"2023-10-11T20:31:46.003Z","dependency_job_id":"43d50e1e-f68b-4756-9888-76e544718f73","html_url":"https://github.com/textpattern/textpattern-forum","commit_stats":{"total_commits":2016,"total_committers":9,"mean_commits":224.0,"dds":0.4662698412698413,"last_synced_commit":"281388728ef4ffe34c03772cc3805f38978be705"},"previous_names":[],"tags_count":42,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/textpattern%2Ftextpattern-forum","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/textpattern%2Ftextpattern-forum/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/textpattern%2Ftextpattern-forum/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/textpattern%2Ftextpattern-forum/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/textpattern","download_url":"https://codeload.github.com/textpattern/textpattern-forum/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243581076,"owners_count":20314167,"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":["fluxbb","forum","theme"],"created_at":"2025-03-14T13:17:47.169Z","updated_at":"2025-03-14T13:17:49.795Z","avatar_url":"https://github.com/textpattern.png","language":"SCSS","readme":"# Textpattern support forum\n\nThis repository contains the source code for the [Textpattern support forum](https://forum.textpattern.com/).\n\nRequires an installation of our [customized clone of FluxBB](https://github.com/textpattern/fluxbb/tree/feature-textpattern-forum).\n\n## Supported web browsers\n\n* Chrome, Edge, Firefox, Safari and Opera the last two recent stable releases.\n* Firefox ESR latest major point release.\n\nOlder versions of the above and other browsers may work, but these are the ones we verify.\n\nBuilding this repository requires:\n\n* [Node.js](https://nodejs.org/)\n* [Grunt](https://gruntjs.com/)\n* [Composer](https://getcomposer.org/)\n\nEnvironment must consist of:\n\n* Apache \u003e=2.2\n* PHP \u003e=7.4\n* MySQL \u003e=5.0.6\n* Unix-like OS, e.g. Linux or macOS\n\n## Setup\n\n### Installing required tools\n\nThe project uses [Grunt](https://gruntjs.com/) to run tasks and [Sass](http://sass-lang.com/) for CSS pre-processing. This creates a few dependencies in addition to your normal PHP required by FluxBB. First make sure you have base dependencies installed: [Node.js](https://nodejs.org/) and [Grunt](https://gruntjs.com/). You can install Node using the [installer](https://nodejs.org/), Composer using the [installer](https://getcomposer.org/), and Grunt with npm:\n\n```ShellSession\n$ npm install -g grunt-cli\n```\n\nConsult the Grunt documentation for more instructions if necessary.\n\n### Setting up Apache virtual host\n\nThe `public/` directory is intended to be set as the server's document root. You can do this by adding a new virtual host to your `httpd.conf`. Along the lines of:\n\n```apache\n\u003cVirtualHost *:80\u003e\n    VirtualHost \"/absolute/path/to/textpattern-forum/public\"\n    ServerName forum.textpattern.test\n\u003c/VirtualHost\u003e\n```\n\nOn a local development server, after this you can use your hosts file to point the development domain to correct location (e.g. back to home), run a local DNS server that resolves .test TLDs, or use a [xip.io](http://xip.io/) domain.\n\n### Installing dependencies\n\nAfter you have the base dependencies taken care of, you can install the project's dependencies. Navigate to the project's directory, and run the dependency managers:\n\n```ShellSession\n$ cd textpattern-forum\n$ npm install\n$ composer install\n```\n\n**npm** installs Node modules for Grunt and **composer** installs PHP libraries.\n\n### Installing FluxBB\n\nOnce you have Grunt installed, you can then install our [customized clone of FluxBB](https://github.com/textpattern/fluxbb/tree/feature-textpattern-forum) - place it in the `public/` directory. Complete FluxBB's installation by following the normal [Installation steps](https://fluxbb.org/docs/v1.5/installing), and use [this as your config.php template](https://github.com/textpattern/textpattern-forum/blob/main/src/setup/config.php.dist).\n\n### Updating and patching FluxBB\n\nPeriodically we update our [customized clone of FluxBB](https://github.com/textpattern/fluxbb/tree/feature-textpattern-forum). To update your FluxBB installation, simply install files from that repository again.\n\nYou may need to [adjust the write permissions](https://fluxbb.org/docs/v1.5/installing#write-permissions) on the `public/cache/` directory after updating.\n\n## Building\n\nThis repository hosts sources and needs to be built before it can be used. After you have installed all dependencies, you will be able to run tasks using Grunt, including building:\n\n```ShellSession\n$ grunt @task@\n```\n\nWhere the `@task@` is either `build` or `watch`.\n\n* The `build` task builds the project.\n* The `watch` task will launch a task that watches for file changes; the project is then automatically built if a source file is modified.\n\n## REST API\n\nWe offer a public API that can be used to retrieve data from the forums and topics. The public end point can be found from `https://forum.textpattern.com/api`. Data can be retrieved as JSON, and options can be passed optional HTTP query parameters. This API is read-only, and all requests must be done using HTTP GET method. You can also ping resource existence with HEAD, but any other methods are rejected.\n\n### Response codes\n\nHTTP status codes can be used to detect the type of response. The server responds with:\n\n* 200: Successful response.\n* 401: You will need to log in to access this resource. The resource may be removed, or private.\n* 404: The resource has been removed, or has never existed.\n* 500: Internal server error.\n* 503: Server is under maintenance.\n\n### Authentication\n\nAuthentication happens using basic HTTP method and regular forum user account.\n\n```ShellSession\n$ curl -u \"username\" https://forum.textpattern.com/api/\n```\n\nIf you request a private or removed resource without being logged in, you will be treated with 401 response:\n\n```ShellSession\n$ curl -I https://forum.textpattern.com/api/posts/401\n```\n\nResponds with:\n\n```\nHTTP/1.0 401 Unauthorized\nDate: Tue, 15 Oct 2013 09:16:42 GMT\nServer: Apache\nWWW-Authenticate: Basic realm=\"Textpattern CMS Support Forum External Syndication\"\nConnection: close\nContent-Type: application/json; charset=UTF-8\n```\n\n### Topics\n\n```\nGET https://forum.textpattern.com/api/topics/:forum\n```\n\nReturns topics from the specified forum.\n\n#### Optional parameters\n\n* **limit**: number items to show. A value between 1 and 50. Defaults to 15.\n* **sort**: either `last_post` or `posted`.\n\n#### Example request\n\n```ShellSession\n$ curl https://forum.textpattern.com/api/topics/2\n```\n\nResponse headers:\n\n```\nHTTP/1.1 200 OK\nDate: Sun, 13 Oct 2013 11:24:49 GMT\nServer: Apache\nContent-Type: application/json; charset=UTF-8\n```\n\nResponse body:\n\n```\n{\n  \"url\": [\"https:\\/\\/forum.textpattern.com\\/index.php\"],\n  \"topic\": [\n    {\n      \"title\": \"Better way to upload media\",\n      \"link\": \"https:\\/\\/forum.textpattern.com\\/viewtopic.php?id=40096\u0026action=new\",\n      \"content\": \"\u003cp\u003e+ lots\u003c\\/p\u003e\",\n      \"author\": {\n        \"name\": \"tye\",\n        \"uri\": \"https:\\/\\/forum.textpattern.com\\/profile.php?id=5751\"\n      },\n      \"posted\": \"26 September 2013 21:51\",\n      \"postedutc\": \"2013-09-24T16:18:48Z\",\n      \"id\": \"40096\"\n    }\n  ]\n}\n```\n\n### Posts\n\n```\nGET https://forum.textpattern.com/api/posts/:topic\n```\n\nReturns replies from a specific public topic.\n\n#### Optional parameters\n\n* **limit**: number items to show. A value between 1 and 50. Defaults to 15.\n\n#### Example request\n\n```ShellSession\n$ curl https://forum.textpattern.com/api/posts/40092\n```\n\nResponse headers:\n\n```\nHTTP/1.1 200 OK\nDate: Sun, 13 Oct 2013 12:24:49 GMT\nServer: Apache\nContent-Type: application/json; charset=UTF-8\n```\n\nResponse body:\n\n```\n{\n  \"url\": [\"https:\\/\\/forum.textpattern.com\\/viewtopic.php?id=40092\"],\n  \"post\": [\n    {\n      \"title\": \"Re: Tag tree best practise: to nest or not to nest\",\n      \"link\": \"https:\\/\\/forum.textpattern.com\\/viewtopic.php?pid=275473#p275473\",\n      \"content\": \"\u003cp\u003eStef, this is really useful \u0026#8211; I\u0026#8217;m on the right track. Thank you very much.\u003c\\/p\u003e\",\n      \"author\": {\n        \"name\": \"gaekwad\",\n        \"uri\": \"https:\\/\\/forum.textpattern.com\\/profile.php?id=7456\"\n      },\n      \"posted\": \"26 September 2013 21:51\",\n      \"postedutc\": \"2013-09-24T16:18:48Z\",\n      \"id\": \"275473\"\n    }\n  ]\n}\n```\n\n## Contributing\n\nWant to help out with the development of Textpattern CMS? Please refer to the [Contributing documentation](https://docs.textpattern.com/development/contributing) for full details.\n\n## License\n\nLicensed under MIT license.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftextpattern%2Ftextpattern-forum","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftextpattern%2Ftextpattern-forum","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftextpattern%2Ftextpattern-forum/lists"}