{"id":13506875,"url":"https://github.com/hex-digital/nuxtpress","last_synced_at":"2025-11-03T04:30:33.337Z","repository":{"id":95868777,"uuid":"222735694","full_name":"hex-digital/nuxtpress","owner":"hex-digital","description":"A modern Nuxt + WordPress starter kit, with support for SPA, Universal and Generated sites.","archived":false,"fork":false,"pushed_at":"2023-01-05T20:29:39.000Z","size":1586,"stargazers_count":56,"open_issues_count":5,"forks_count":8,"subscribers_count":10,"default_branch":"master","last_synced_at":"2024-12-27T03:12:25.871Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://github.com/hex-digital/nuxtpress","language":"Vue","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hex-digital.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"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,"roadmap":null,"authors":null}},"created_at":"2019-11-19T16:05:17.000Z","updated_at":"2024-12-04T00:16:53.000Z","dependencies_parsed_at":"2023-04-24T21:47:44.448Z","dependency_job_id":null,"html_url":"https://github.com/hex-digital/nuxtpress","commit_stats":null,"previous_names":[],"tags_count":2,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hex-digital%2Fnuxtpress","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hex-digital%2Fnuxtpress/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hex-digital%2Fnuxtpress/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hex-digital%2Fnuxtpress/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hex-digital","download_url":"https://codeload.github.com/hex-digital/nuxtpress/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239406497,"owners_count":19633025,"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":[],"created_at":"2024-08-01T01:00:59.223Z","updated_at":"2025-11-03T04:30:33.271Z","avatar_url":"https://github.com/hex-digital.png","language":"Vue","funding_links":[],"categories":["Uncategorized"],"sub_categories":["Uncategorized"],"readme":"# NuxtPress - WordPress x Nuxt Development Environment\n\n\u003cp align=\"center\"\u003e\n  \u003cimg width=\"300\" height=\"300\" src=\"https://user-images.githubusercontent.com/2754728/74832907-462a9780-5310-11ea-9cc7-9a581fcde91d.png\"\u003e\n\u003c/p\u003e\n\n**NuxtPress** combines [**_WordPress_**](https://wordpress.com/), the worlds biggest CMS with [**_NuxtJS_**](https://nuxtjs.org/),\na brilliant front-end application framework, built on top of [**_Vue_**](https://vuejs.org/v2/guide/).\n\nThis README contains the quick start and intro documentation.  \nCheck out [the documentation directory](docs) for more detailed information on NuxtPress.\n\n- [Quick Start](#quick)\n- [Introduction](#intro)\n- [Getting started](docs/1-GettingStarted.md#start)\n  - [With Docker](docs/1-GettingStarted.md#with-docker)\n    - [Setup WordPress](docs/1-GettingStarted.md#setup-wp)\n    - [Setup Nuxt.js](docs/1-GettingStarted.md#setup-nuxt-docker)\n    - [Custom container configuration](docs/1-GettingStarted.md#custom-container-configuration)\n  - [Without Docker](docs/1-GettingStarted.md#without-docker)\n    - [Setup WordPress](docs/1-GettingStarted.md#setup-wp-no-docker)\n    - [Setup Nuxt.js](docs/1-GettingStarted.md#setup-nuxt-no-docker)\n    - [URL and Port Configuration](docs/1-GettingStarted.md#port-config)\n- [WordPress Rest API endpoints](docs/2-WordPressRestApi.md#ep)\n  - [Extensions to the API endpoints](docs/2-WordPressRestApi.md#epp)\n    - [Front-page](docs/2-WordPressRestApi.md#epp-front)\n    - [Menus](docs/2-WordPressRestApi.md#epp-menu)\n    - [Slugs](docs/2-WordPressRestApi.md#epp-slugs)\n    - [Meta queries](docs/2-WordPressRestApi.md#epp-meta)\n    - [Taxonomy queries](docs/2-WordPressRestApi.md#epp-tax)\n    - [Geo queries](docs/2-WordPressRestApi.md#epp-geo)\n    - [Custom post types](docs/2-WordPressRestApi.md#epp-cpt)\n- [Development Tools](docs/3-DevelopmentTools.md#development-tools)\n  - [StoryBook](docs/3-DevelopmentTools.md#storybook)\n  - [Jest (Unit + Snapshot Testing)](docs/3-DevelopmentTools.md#jest)\n  - [SCSS](docs/3-DevelopmentTools.md#scss)\n  - [Lint Staged Files on Commit](docs/3-DevelopmentTools.md#lint-staged)\n  - [Scripts](docs/3-DevelopmentTools.md#scripts)\n    - [Working with the containers](docs/3-DevelopmentTools.md#scripts-containers)\n      - [WP-CLI and yarn](docs/3-DevelopmentTools.md#scripts-containers-tools)\n    - [Scaffolding](docs/3-DevelopmentTools.md#scripts-scaffolding)\n- [Generate and Deploy](docs/4-GenerateStaticSite.md#deploy)\n- [Links](#links)\n- [Credits](#cred)\n\n## Quick start\n\n\u003ca name=\"quick\"/\u003e\n\n    git clone https://github.com/hex-digital/nuxtpress.git\n    cd nuxtpress\n    docker-compose up -d wp.nuxtpress\n    cd nuxt \u0026\u0026 cp .env.dist .env \u0026\u0026 cp assets/scss/settings/_settings.config.dist.scss assets/scss/settings/_settings.config.scss\n    yarn install \u0026\u0026 yarn dev\n\n- [http://localhost:3080/install.php](http://localhost:3080/install.php) - Install WordPress\n- [http://localhost:3080/wp-admin/options-permalink.php](http://localhost:3080/wp-admin/options-permalink.php) - Set permalinks to _Post name_\n- [http://localhost:3080/wp-admin/themes.php](http://localhost:3080/wp-admin/themes.php) - Activate **nuxtpress**-theme\n- [http://localhost:3000](http://localhost:3000) - Done\n\n## Introduction\n\n\u003ca name=\"intro\"/\u003e\n\nNuxtPress aims to provide a ready to use development environment, combining WordPress with Nuxt.\nIncluded are:\n\n- Fully dockerized **_WordPress_** and **_NuxtJS_** containers, setup in one command: `docker-compose up -d`\n\n- Extended Rest API gives easy access to meta-fields, featured media menus and front-page config.\n\n- Latest **_NuxtJS_**, with a WordPress `$wp` object, to connect to the extended **_WordPress_** Rest API.\n\nThis allows you to skip all the backend coding, but provides the flexibility to extend the backend if you want to.\n\n## Showcase\n\n\u003ca name=\"showcase\"/\u003e\n\nThe following sites are powered by NuxtPress:\n\n[https://prostack.uk](https://prostack.uk)\n\nGet in touch to have your site listed here.\n\n## Links\n\n\u003ca name=\"links\"/\u003e\n\n[WUXT Headless WordPress API Extensions](https://wordpress.org/plugins/wuxt-headless-wp-api-extensions/): Plugin which includes all our API extensions.\n\n## Credits\n\n\u003ca name=\"cred\"/\u003e\n\n[@northosts](https://github.com/northosts) for the fantastic Wuxt framework on which NuxtPress is hugely dependent. [https://github.com/northosts/wuxt](https://github.com/northosts/wuxt)  \n[@yashha](https://github.com/yashha/wp-nuxt/commits?author=yashha) for the excellent idea with the `$wp` object, first implemented in [https://github.com/yashha/wp-nuxt](https://github.com/yashha/wp-nuxt)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhex-digital%2Fnuxtpress","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhex-digital%2Fnuxtpress","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhex-digital%2Fnuxtpress/lists"}