{"id":15713606,"url":"https://github.com/martenframework/realworld","last_synced_at":"2025-05-07T22:29:23.437Z","repository":{"id":217008273,"uuid":"656465489","full_name":"martenframework/realworld","owner":"martenframework","description":"A RealWorld application built with Marten.","archived":false,"fork":false,"pushed_at":"2025-04-13T11:58:16.000Z","size":310,"stargazers_count":11,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-13T12:39:28.244Z","etag":null,"topics":["crystal","crystal-lang","demo","demo-app","framework","marten","realworld","web"],"latest_commit_sha":null,"homepage":"","language":"Crystal","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/martenframework.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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,"zenodo":null}},"created_at":"2023-06-21T02:38:53.000Z","updated_at":"2025-04-13T11:58:20.000Z","dependencies_parsed_at":null,"dependency_job_id":"20899b75-638d-4735-b943-05097e2f7ca4","html_url":"https://github.com/martenframework/realworld","commit_stats":null,"previous_names":["martenframework/realworld"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/martenframework%2Frealworld","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/martenframework%2Frealworld/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/martenframework%2Frealworld/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/martenframework%2Frealworld/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/martenframework","download_url":"https://codeload.github.com/martenframework/realworld/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252964448,"owners_count":21832695,"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":["crystal","crystal-lang","demo","demo-app","framework","marten","realworld","web"],"created_at":"2024-10-03T21:32:28.447Z","updated_at":"2025-05-07T22:29:23.423Z","avatar_url":"https://github.com/martenframework.png","language":"Crystal","funding_links":[],"categories":["Built with Marten"],"sub_categories":["Sessions"],"readme":"# ![RealWorld Example App](logo.png)\n\n[![CI](https://github.com/martenframework/realworld/workflows/Specs/badge.svg)](https://github.com/martenframework/realworld/actions) [![CI](https://github.com/martenframework/realworld/workflows/QA/badge.svg)](https://github.com/martenframework/realworld/actions)\n\n\u003e ### [Marten](https://github.com/martenframework/marten) codebase containing real world examples (CRUD, auth, advanced patterns, etc) that adheres to the [RealWorld](https://github.com/gothinkster/realworld) spec and API.\n\nThis codebase was created to demonstrate a fully fledged fullstack application built with the **[Marten web framework](https://github.com/martenframework/marten)** including CRUD operations, authentication, routing, pagination, and more.\n\nWe've gone to great lengths to adhere to the **[Marten](https://github.com/martenframework/marten)** community styleguides \u0026 best practices.\n\nFor more information on how to this works with other frontends/backends, head over to the [RealWorld](https://github.com/gothinkster/realworld) repo.\n\n## System requirements\n\n* [Crystal](https://crystal-lang.org/) 1.16+\n* [Node.js](https://nodejs.org/en/) - 18.x\n\n## Installation\n\nIf all the above system dependencies are properly installed on the target system, it should be possible to install the project using the following command:\n\n```shell\n$ make\n```\n\nThis command will take care of the installation of the required dependencies (Crystal and Node.js) and will (i) build the development assets and (ii) setups the project's database using SQLite.\n\n## Running the development server\n\nThe development server can be started using the following command:\n\n```shell\n$ make server\n```\n\nThe development server should be accessible at http://127.0.0.1:8000.\n\n\n## Frontend development\n\nThis project uses [Gulp](https://gulpjs.com/) and [Webpack](https://webpack.js.org) to bundle the assets of the application. Client-side scripts are written using **vanilla JS** and the stylesheets used are the precompiled ones that are [provided by the Realworld project](https://realworld-docs.netlify.app/docs/specs/frontend-specs/styles). All the tools necessary to work on the assets of this project should've been installed when running `make` in the previous sections.\n\nClient-side scripts are stored in the `src/assets/build_dev` folder. Whenever those scripts need to be recompiled, the following command can be used:\n\n```shell\nnpm run gulp -- build\n```\n\nFinally, a Webpack dev server can also be launched in order to use hot reloading if necessary. To do so, the following command can be used:\n\n```shell\nnpm run gulp -- webpack-dev-server\n```\n\nNote that the Marten development server should be started in another terminal _after_ the Webpack dev server has been started.\n\n## Running the test suite\n\nThe test suite can be run using the following command:\n\n```shell\n$ make tests\n```\n\nCode quality checks can be triggered using the following command:\n\n```shell\n$ make qa\n```\n\n## License\n\nMIT. See `LICENSE` for more details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmartenframework%2Frealworld","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmartenframework%2Frealworld","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmartenframework%2Frealworld/lists"}