Skip to content

Latest commit

 

History

History
executable file
·
99 lines (67 loc) · 2.5 KB

README.md

File metadata and controls

executable file
·
99 lines (67 loc) · 2.5 KB

nuxt-typo3

npm downloads npm version standard js License

TYPO3 module for Nuxt.js and TYPO3 headless provides API handling and frontend rendering.

TYPO3 & Headless Ext compability

TYPO3 >= v11.5 & Headless version 3.x -> [email protected] (master)

TYPO3 < 11.5 & Headless version 2.x -> [email protected] (0.9x)

Features

✅ Handle dynamic API routes

✅ Frontend layouts

✅ Backend layouts

✅ Multilanguage

✅ Meta tags provided by API

✅ Most of the standard TYPO3 Content Elements

✅ SSR Ready

Setup

Installation

Install with yarn

yarn add nuxt-typo3

Install with npm

npm install nuxt-typo3

Configuration

  1. Add typo3 object to your nuxt.config.js to configure all required settings.
{
  modules: [
    'nuxt-typo3',
  ],

  typo3: {
    baseURL: 'https://yourwebsite.com',
    api: {
      baseURL: 'https://api.yourwebsite.com'
    },
    i18n: {
      locales: ['en', 'pl', 'de'],
      defaultLocale: 'en'
    }
  }
}
  1. By default this plugin uses dynamic routing (_.vue), please remove index.vue from pages directory - now your pages provides TYPO3 API.

See In action

Development

  1. Clone this repository
  2. Install dependencies using yarn install
  3. Start development server using yarn dev

Please read contributing guide

License

MIT License

Copyright (c) MACOPEDIA