{"id":13907053,"url":"https://github.com/facebookarchive/instant-articles-builder","last_synced_at":"2025-07-18T04:33:39.686Z","repository":{"id":38715767,"uuid":"110612392","full_name":"facebookarchive/instant-articles-builder","owner":"facebookarchive","description":"Instant Articles Rules Editor","archived":true,"fork":false,"pushed_at":"2023-04-20T13:20:34.000Z","size":4217,"stargazers_count":125,"open_issues_count":45,"forks_count":67,"subscribers_count":26,"default_branch":"main","last_synced_at":"2024-08-07T23:49:52.252Z","etag":null,"topics":["editor","facebook","instant-articles"],"latest_commit_sha":null,"homepage":"https://facebook.github.io/instant-articles-builder","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/facebookarchive.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2017-11-13T22:59:25.000Z","updated_at":"2024-07-01T18:34:32.000Z","dependencies_parsed_at":"2023-09-24T15:25:47.263Z","dependency_job_id":null,"html_url":"https://github.com/facebookarchive/instant-articles-builder","commit_stats":{"total_commits":256,"total_committers":14,"mean_commits":"18.285714285714285","dds":0.59765625,"last_synced_commit":"22f98ab13d1a8a01e7da04f1fe8de8ed1e4806fd"},"previous_names":["facebookarchive/instant-articles-builder"],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/facebookarchive%2Finstant-articles-builder","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/facebookarchive%2Finstant-articles-builder/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/facebookarchive%2Finstant-articles-builder/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/facebookarchive%2Finstant-articles-builder/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/facebookarchive","download_url":"https://codeload.github.com/facebookarchive/instant-articles-builder/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":226353552,"owners_count":17611721,"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":["editor","facebook","instant-articles"],"created_at":"2024-08-06T23:01:46.951Z","updated_at":"2024-11-25T15:31:06.651Z","avatar_url":"https://github.com/facebookarchive.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"# Facebook Instant Articles Builder\n\n## 🚨 Important Note\n\n**⚠️ Instant Articles is no longer available, starting April 20, 2023**\n\nAll related developer tools have been archived.\n\n---\n\n**Instant Articles Builder** helps you to create a template to build [Facebook Instant Articles](https://instantarticles.fb.com/) from articles on your website.\n\nTry it out (Windows/Mac): https://facebook.github.io/instant-articles-builder/\n\n## Building from source\n\nRun (on the root of the project):\n\n```\nnpm install\n```\n\n### Launching the App\n\nJust run (on the root of the project):\n\n```\nnpm start\n```\n\n### Testing\n\nRun the following command (on the root of the project):\n\n```\nnpm test\n```\n\n## Preview config\n\nTo enable the experimental preview of the Instant Article, you can run the webserver locally or point to a remote one.\n\nThere are three environment variables that are used to configure the webserver:\n\n- `IA_BUILDER_START_LOCAL_PREVIEW_WEBSERVER` (true|false). Optional.\n  - When true, when launching the Builder it will start the local webserver (requires php to be installed locally)\n  - Default value: true\n- `IA_BUILDER_PREVIEW_WEBSERVER_HOST` ({protocol}:{hostname}). Optional.\n  - Example: http://webserver.example.org\n  - When present, overrides the location where the webserver is\n  - Default value: http://localhost\n- `IA_BUILDER_PREVIEW_WEBSERVER_PORT` ({port number}). Optional.\n  - When present overrides the port of the webserver\n  - Default value: 8105\n\n### Local webserver\n\nTo enable the preview using a local webserver (which requires PHP to be installed in your local environment) navigate to the `webserver` directory:\n\n```\ncd webserver\n```\n\nAnd install the composer dependencies:\n\n```\ncomposer install\n```\n\n### Remote webserver\n\nYou may also point to a remote webserver for the preview. To configure the remote webserver you can use the mentioned environment variables, or if you are building from source you can create a file called `.env` in the root of the repo with content similar to:\n\n```\nIA_BUILDER_START_LOCAL_PREVIEW_WEBSERVER=false\nIA_BUILDER_PREVIEW_WEBSERVER_HOST=http://localhost\nIA_BUILDER_PREVIEW_WEBSERVER_PORT=8105\n```\n\nYou can use the [Docker](https://www.docker.com/) image included in this repo under `docker/webserver` to get a webserver instance running locally in Docker.\n\n#### Single container (no cache)\n\nYou can get a single container with the webserver without cache by running the following command to build the image:\n\n```\ndocker build ./docker/webserver -t ia-webserver\n```\n\nand then the following command to run your container and make it accessible through the 8105 port (which is also configurable):\n\n```\ndocker run -it --rm -p 8105:8000 --name ia-webserver ia-webserver:latest\n```\n\n#### Docker-compose (with cache)\n\nUpdate .env with the port according with docker-compose file. As default, memcache it is configured: \"8107:8000\".\n\nYou can get a webserver with cache (using [memcached](https://memcached.org/)) by running the following command from the `Docker/webserver/ folder:\n\n```\ndocker-compose up\n```\n\nYou can take a look at the cache stats by going to http://localhost:11212.\n\nonce you are done you can stop both containers with the following command:\n\n```\ndocker-compose down\n```\n\n## License\nPlease read the [LICENSE](https://github.com/facebook/instant-articles-builder/blob/master/LICENSE) file for more information.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffacebookarchive%2Finstant-articles-builder","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffacebookarchive%2Finstant-articles-builder","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffacebookarchive%2Finstant-articles-builder/lists"}