## File: README.md ### See how [_the exact same_ Medium.com clone](https://demo.realworld.show) is built using different [frontends](https://codebase.show/projects/realworld?category=frontend) and [backends](https://codebase.show/projects/realworld?category=backend) You can combine any frontend with any backend, because **they all adhere to the same [API spec](specs/api/)** While most "todo" demos provide an excellent cursory glance at a framework's capabilities, they typically don't convey the knowledge required to actually build _real_ applications with it โ€” nor the real-world constraints a minimal demo never has to face. **RealWorld** solves this problem by providing the same demo app for each framework, at a sweet spot between simplicity and breadth. Join us on [GitHub Discussions!](https://github.com/realworld-apps/realworld/discussions) ๐ŸŽ‰ # Implementations Over 100 implementations have been created using various languages, libraries, and frameworks. Explore them on [**CodebaseShow**](https://codebase.show/projects/realworld). ## Spec-compliant backends These backends pass the full [API spec test suite](https://docs.realworld.show/specifications/backend/introduction/): - [**Nitro + Prisma + Zod**](https://github.com/realworld-apps/nitro-prisma-zod-realworld-example-app) โ€” TypeScript - [**Django Ninja**](https://github.com/c4ffein/realworld-django-ninja) โ€” Python # Create a new implementation [**Create a new implementation >>>**](https://docs.realworld.show/implementation-creation/introduction/) Or you can [view upcoming implementations (WIPs)](https://github.com/realworld-apps/realworld/discussions/categories/wip-implementations). # Learn more - [Documentation introduction](https://docs.realworld.show/introduction/) - Every tutorial is built against the same [API spec](specs/api/) to ensure modularity of every frontend & backend - A shared [CSS theme](assets/theme/styles.css) is provided to build frontend implementations with identical UI/UX - A shared [E2E test suite](specs/e2e/) is available to validate frontend implementations - There is a hosted version of the backend API available for public usage at [api.realworld.show](https://api.realworld.show), no API keys required โ€” demo accounts are provided, and real accounts can't see each other - There is an angular frontend plugged to this backend available at [demo.realworld.show](https://demo.realworld.show) - Interested in creating a new RealWorld stack? View our [starter guide & spec](https://docs.realworld.show/implementation-creation/introduction/) # Logo Attribution See [LICENSES_LOGOS.md](docs/non-included/LICENSES_LOGOS.md) for framework logo licensing and attribution details. # Active Maintainers - **[c4ffein](https://github.com/c4ffein) - Maintainer** - maintains the spec, the test suites and the [demo website](https://demo.realworld.show) - **[Manuel Vila](https://github.com/mvila) - Maintainer** - creator of the [Layr framework](https://layrjs.com) and the [CodebaseShow website](https://codebase.show/) --- ## File: CLAUDE.md # CLAUDE.md ## What this repo is This is the **RealWorld spec & docs hub** โ€” *not* an implementation. It defines the contract that every RealWorld frontend and backend adheres to, and hosts the test suites used to validate them. Nothing here is a runnable app. - `specs/api/` โ€” the API contract: `openapi.yml` plus the **Hurl** and **Bruno** test suites that a backend must pass. - `specs/e2e/` โ€” a shared **Playwright** suite that validates a frontend, plus `SELECTORS.md` (the selector contract) and `playwright.base.ts`. - `docs/` โ€” the Astro/Starlight site published at . - `Makefile` โ€” entry points (run `make help`). - `CONTRIBUTING.md` โ€” the human contribution process. ## If you are here as a submodule / vendored dependency An implementation embeds this repo to test itself against the spec (the E2E suite is literally consumed as `./e2e`). If that's why you're reading this: - **Fix the implementation, never edit the spec or tests to make them pass.** Files under `specs/` are the source of truth a failing implementation must conform to. - Edit files here only when the task is explicitly about *changing the RealWorld spec itself*. ## Conventions - Use **`bun`**, not `npm`/`node`, for everything in this repo. - **Hurl is the source of truth** for the API suite; the Bruno collection is generated from it. Don't hand-edit `specs/api/bruno/` โ€” change the Hurl files and regenerate. - Docs URLs are written with a trailing slash. ## Running the test suites API suite (point `HOST` at a running backend, run from `specs/api/`): ``` HOST=http://localhost:3000/api ./run-api-tests-hurl.sh # source of truth HOST=http://localhost:3000/api ./run-api-tests-bruno.sh # generated mirror ``` Regenerate / verify the Bruno collection: ``` make bruno-generate # rebuild specs/api/bruno/ from the Hurl files make bruno-check # CI check: fail if bruno/ is out of sync ``` E2E suite: an implementation extends `specs/e2e/playwright.base.ts` (override `baseURL` and `webServer`) and must satisfy `specs/e2e/SELECTORS.md`. See . ## Working on the docs ``` make documentation-setup # cd docs && bun install make documentation-dev # local dev server make documentation-build # production build ``` ## Answering "how do I build an implementation?" Implementations live in their **own** repos, not here. Point users to: - Backends โ†’ validate against `specs/api/` (the OpenAPI spec + Hurl/Bruno suites). - Frontends โ†’ use the shared CSS theme + `specs/e2e/` (the Playwright suite + selector contract). - The full guide: . --- ## File: CONTRIBUTING.md # Contributing to RealWorld We would love for you to contribute to RealWorld and help make it even better than it is today! As a contributor, here are the guidelines we would like you to follow: - [Question or Problem?](#question) - [Issues and Bugs](#issue) - [Feature Requests](#feature) - [Submission Guidelines](#submit) - [Coding Rules](#rules) - [Commit Message Guidelines](#commit) ## Got a Question or Problem? Do not open issues for general support questions as we want to keep GitHub issues for bug reports and feature requests. For open discussions, we encourage you to use the [Github Discussions][github-discussions] channels. ## Interested in creating Conduit for your framework? To create an official implementation of Conduit, check out our [Github Discussions](https://github.com/realworld-apps/realworld/discussions/categories/wip-implementations) and see if anyone else has requested and/or is already working on your framework. If not, feel free to start working on one! Start [here][github-spec]! ## Found a Bug? If you find a bug in the project, you can help us by [submitting an issue][github-issue] to our [GitHub Repository][github]. Even better, you can [submit a Pull Request](#submit-pr) with a fix. ## Missing a Feature? You can _request_ a new feature by [submitting an issue](#submit-issue) to our GitHub repository. If you would like to _implement_ a new feature, please submit an issue with a proposal for your work **FIRST**, to be sure that we can use it. Please consider what kind of change it is: - For a **Major Feature**, first open an issue and outline your proposal so that it can be discussed. This will also allow us to better coordinate our efforts, prevent duplication of work, and help you to craft the change so that it is successfully accepted into the project. - **Small Features** can be crafted and directly [submitted as a Pull Request](#submit-pr). ## Submission Guidelines ### Submitting an Issue Before you submit an issue, please search the issue tracker, maybe an issue for your problem already exists and the discussion might inform you of workarounds readily available. You can file new issues by selecting from our [new issue templates][github-choose] and filling out the issue template. ### Submitting a Pull Request (PR) Before you submit your Pull Request (PR) consider the following guidelines: 1. Search [GitHub](https://github.com/realworld-apps/realworld/pulls) for an open or closed PR that relates to your submission. You don't want to duplicate effort. 1. Be sure that an issue describes the problem you're fixing, or documents the design for the feature you'd like to add. Discussing the design up front helps to ensure that we're ready to accept your work. 1. Fork the realworld-apps/realworld repo. 1. Make your changes in a new git branch: ```bash git checkout -b my-fix-branch master ``` 1. Create your patch. 1. Commit your changes using a descriptive commit message that follows our [commit message conventions](#commit). 1. Push your branch to GitHub: ```bash git push origin my-fix-branch ``` 1. In GitHub, send a pull request to `realworld:master`. - If we suggest changes then: - Make the required updates. - Rebase your branch and force push to your GitHub repository (this will update your Pull Request): ```bash git rebase master -i git push -f ``` That's it! Thank you for your contribution! #### After your pull request is merged After your pull request is merged, you can safely delete your branch and pull the changes from the master (upstream) repository: - Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows: ```bash git push origin --delete my-fix-branch ``` - Check out the master branch: ```bash git checkout master -f ``` - Delete the local branch: ```bash git branch -D my-fix-branch ``` - Update your master with the latest upstream version: ```bash git pull --ff upstream master ``` ## Commit Message Guidelines > These guidelines have been added to the project starting from February 2025 We have very precise rules over how our git commit messages can be formatted. This leads to **more readable messages** that are easy to follow when looking through the **project history**. ### Commit Message Format Each commit message consists of a **header**, a **body** and a **footer**. The header has a special format that includes a **type**, a **scope** and a **subject**: ``` ():