hojalatheef/sitepackageone

Site package for sitepackageone distribution

dev-main 2024-08-07 17:12 UTC

Requires

• typo3/cms-core: ^13.2

Requires (Dev)

• roave/security-advisories: dev-latest

GPL-2.0-or-later

• Hoja Mustaffa Abdul Latheef

• package
• template
• site
• typo3
• TYPO3 CMS

README

SitePackageOne is a TYPO3 extension designed to provide a comprehensive one-page website template. It includes pre-configured templates, TypoScript setup, and custom content elements tailored for a modern, responsive one-page site.

Requirements

• TYPO3 v13
• PHP 8.2 or higher

Installation

composer req hojalatheef/sitepackageone

2. Include TypoScript Template

1. Go to Template Module:

   • Navigate to "WEB" > "Template".

2. Select Root Page:

   • Select your root page.

3. Edit Template Record:

   • Click on "Info/Modify" and then "Edit the whole template record".

4. Include Static TypoScript:

   • In the "Includes" tab, add sitepackageone to the "Include static (from extensions)" field.

3. Set Up Root Page

Ensure you have a root page created in the "WEB" > "Page" module.

• Set the root page as the site root by right-clicking on the page and selecting "Edit".
• In the "Behavior" tab, check the "Use as Root Page" option.

4. Customize Your One-Page Template

Create Content Elements

• Go to "WEB" > "Page".
• Create and configure content elements on your root page using the provided templates.

Edit HTML Templates

• The HTML templates are located in EXT:sitepackageone/Resources/Private/Templates.
• Customize these templates to fit your design needs.

5. Add Custom Styles and Scripts

CSS and JS Files

• Add your custom CSS files to EXT:sitepackageone/Resources/Public/CSS.
• Add your custom JavaScript files to EXT:sitepackageone/Resources/Public/JavaScript.

Include Custom Styles and Scripts in TypoScript

Open the TypoScript setup file located at EXT:sitepackageone/Configuration/TypoScript/setup.typoscript and include your custom styles and scripts as needed:

page.includeCSS {
    file1 = EXT:sitepackageone/Resources/Public/CSS/styles.css
}

page.includeJSFooter {
    file1 = EXT:sitepackageone/Resources/Public/JavaScript/scripts.js
}

Development

Local Development with DDEV

1. Start DDEV Environment: Ensure you have DDEV installed on your system.

   ddev start

2. Access TYPO3 Backend: Navigate to http://sitepackageone.ddev.site/typo3 and log in with your admin credentials.

License

SitePackageOne is released under the MIT License. See the LICENSE file for more details.