Page MenuHomePhabricator

Create a basic "Hello world" example of how to use Codex outside MediaWiki
Closed, ResolvedPublic1 Estimated Story Points

Description

Similar to T332753, but outside MediaWiki. We should write something that would be deployable in Toolforge, but I don't know enough about Toolforge to know what kind of underlying framework we should use (Vite? Flask? Something else?)

See also T330350 for additional suggestions as to what could be demonstrated.

  • Create a repo in Gitlab (or maybe create one codex-examples repo for both this and T322753?)
  • Add basic skeleton of a web-based tool
  • Demonstrate JS use of Codex
Update 4/20/23

I've created the following project over at Gitlab: https://gitlab.wikimedia.org/repos/design-systems/codex-starter-template

This project demonstrates how to build a single-page Vue app (using Codex) with Vite as a build tool. The app functions similar to the NearbyPages feature on MediaWiki, where the user can click a button to show nearby pages and is presented with a list of Codex Card components displaying the results.

This project *does not* include CSS-only components – I think that a simple SPA style app is a better starter template here, and CSS components aren't really necessary for that.

Please review and let me know if further changes are required before the Hackathon. Otherwise, feel free to close this task.

Event Timeline

Restricted Application added a subscriber: Aklapper. · View Herald Transcript

@egardner points out we can use https://github.com/egardner/codex-starter as a starting point, it probably has most of what we need already

Restricted Application triaged this task as High priority. · View Herald TranscriptMar 27 2023, 4:24 PM
egardner set the point value for this task to 1.
egardner updated the task description. (Show Details)