sitegeist / neos-base-distribution
Sitegeist Neos Base Distribution
Installs: 230
Dependents: 0
Suggesters: 0
Security: 0
Stars: 12
Watchers: 12
Forks: 13
Open Issues: 14
Language:TypeScript
Requires
- flowpack/nodetemplates: ^1.3
- neos/neos: ~8.3.0
- neos/redirecthandler-databasestorage: ^5.0
- neos/redirecthandler-neosadapter: ^4.3
- neos/redirecthandler-ui: ^2.4
- neos/seo: ^3.0
- packagefactory/atomicfusion-classnames: ^1.0
- packagefactory/atomicfusion-proptypes: ^2.0
- sitegeist/archaeopteryx: ^1.0
- sitegeist/chitchat: ~1.2
- sitegeist/csvpo: ^1.3
- sitegeist/iconoclasm: ^1.0
- sitegeist/kaleidoscope: ^6.0
- sitegeist/klarschiff: ~3.0
- sitegeist/monocle: ~7.2
- sitegeist/noderobis: ~1.1
- sitegeist/pyranodis: ~1.0
- sitegeist/stampede: ^1.1
- vendor/site: ^1.0
- vendor/wheelinventor: ^1.0
Requires (Dev)
- deployer/deployer: ^7.0
- editorconfig-checker/editorconfig-checker: ^10.0
- mikey179/vfsstream: ^1.6.10
- neos/buildessentials: ^8.3.x-dev
- phpstan/phpstan: ~1.8
- phpunit/phpunit: ~9.1
- sitegeist/chantalle: ^1.0
- sitegeist/magicwand: ^4.3
- sitegeist/noderobis: ^1.0
- squizlabs/php_codesniffer: ^3.4
Suggests
- ext-pdo_sqlite: For running functional tests out-of-the-box this is required
- dev-main
- v8.3.1
- v8.3.0
- v8.2.1
- v8.2.0
- v7.3.0
- v7.1.4
- v7.1.3
- v7.1.2
- v7.1.1
- v7.1.0
- v7.0.1
- v7.0.0
- v5.3.0
- v5.2.0
- v5.0.0
- dev-supportWheelInventor-basicContentElements
- dev-neos9
- dev-85649-videoElement
- dev-mr/83765/ditchTsLoaderInFavorOfEsBuildLoader
- dev-supportWheelInventor
- dev-mficzel-add-noderobis-config
- dev-task/neos83AndChitChat
- dev-dependabot/npm_and_yarn/minimist-1.2.8
- dev-mficzel-patch-4
- dev-dependabot/npm_and_yarn/http-cache-semantics-4.1.1
- dev-task/requireNoderobisAsDevDependency
- dev-task/uodateForPhp81AndNeos82
- dev-dependabot/npm_and_yarn/json5-1.0.2
- dev-dependabot/npm_and_yarn/qs-6.5.3
- dev-dependabot/npm_and_yarn/decode-uri-component-0.2.2
- dev-dependabot/npm_and_yarn/loader-utils-1.4.2
- dev-everything8.1
- dev-dependabot/npm_and_yarn/terser-5.14.2
- dev-task/71632/addSitegeistFocusPoints
- dev-dependabot/npm_and_yarn/nanoid-3.3.4
- dev-dependabot/npm_and_yarn/node-fetch-2.6.7
- dev-task/tailwind3
- dev-dependabot/npm_and_yarn/tar-4.4.19
- dev-dependabot/npm_and_yarn/postcss-8.2.13
- dev-dependabot/npm_and_yarn/trim-off-newlines-1.0.3
- dev-dependabot/npm_and_yarn/shelljs-0.8.5
- dev-task/upgradeNodeStructures
- dev-task/modeNodeTypesFolderOfWheelInventorPackage
- dev-wheelInventor-frontend
- dev-task/neos73andIconoclasm
- dev-task/000/removeLastVisitedNodeJs
- dev-task/63339/optimizeImages
- dev-task/adjustDdevNameDuringSetup
- dev-task/cleanupJsAndCssArtefacts
- dev-task/webPageAndJsonLd
- dev-task/addArcheaopteryxToBaseDist
- dev-task/updateDdevConfiguration
- dev-wheelInventor
- dev-wheelinve
- dev-feature/moveFrontendBuildIntoSitePackage
- dev-task/neos71
- dev-feature/stampede
- dev-task/neos70
- dev-task/neos53
- dev-feature/backstopJsVisualRegressionTesting
- dev-feature/deployerConfig
- dev-task/someMinorRenovations
- dev-ddev
- dev-task/preparePackagistRegistration
- dev-mficzel-patch-2
- dev-mficzel-patch-3
- dev-feature/neos5-update
- dev-task/removeObsoleteFrontendDepencies
- dev-mficzel-patch-1
- dev-feature/neos-1
- dev-feature/redisConfig
- dev-feature/addMailhog
- dev-feature/404handling
- dev-feature/documentRendering
- dev-feature/neos43
- dev-feature/addCloneCommandAndCreateHostuser
- dev-bugfix/nodeTypeTranslations
- dev-task/addPostCssNested
- dev-feature/integrate-typescript
- dev-feature/addEsNeos
- dev-feature/use-imagick
- dev-task/refactor-docker-setup
- dev-feature/integrate-plop
- dev-feature/excludeTestsFromBuild
- dev-feature/semantic-tests
- dev-feature/global-makefile-overrides
This package is auto-updated.
Last update: 2024-11-07 10:58:12 UTC
README
Installation
Create a project based on the sitegeist base distribution
composer create-project sitegeist/neos-base-distribution customer-folder
Migrate database and add Admin user
ddev flow doctrine:migrate ddev flow user:create --roles Administrator admin admin Admin User
Create custom site package (optional)
Usually you will create a new site-package for your project. This repository contains four example packages that sitegeist uses
as starting point for new projects. The Vendor.Site
package uses a build stack with css-modules and css + typescript colocation, while
the Vendor.WheelInventor
package is built using TailwindCss.
Vendor.SupportWheelInventor
uses PackageFactory.AtomicFusion.PresentationObjects
for integration
and Vendor.Shared
as a shared kernel package to store shared elements like presentational components.
A site package has a package key that consists of a vendor Namespace and Package name that are seperated by a dot. You should always
choose a unique package key in the customer namespace to implement custom designs. A good example would be Acme.Marketing
.
In the following examples __your_site_package_key__
refers to the package key you choose here.
You can choose to copy the included Vendor.Site
package, the Vendor.WheelInventor
or the Vendor.SupportWheelInventor
and Vendor.Shared
package(s) into the project namespace:
ddev flow package:adopt Vendor.Site __your_site_package_key__
or:
ddev flow package:adopt Vendor.WheelInventor __your_site_package_key__
or:
ddev flow package:adopt Vendor.SupportWheelInventor __your_site_package_key__ ddev flow package:adopt Vendor.Shared __your_shared_package_key__
If you are improving the sitegeist/neos-base-distribution you likely want to skip this and adjust the example packages as they are.
Background: Vendor.Site
is a blank site package with no defined frontend components, no content node types and a CSS Modules setup. Vendor.WheelInventor
and Vendor.SupportWheelInventor
uses Tailwind CSS and defines a lot of default frontend components and content node types. Use the latter to quickstart projects of medium size.
After cloning the site package you have to require the newly created package via composer.
ddev composer require customer/site
After which you may decide to remove the packages Vendor.Site
, Vendor.WheelInventor
, Vendor.SupportWheelInventor
, Vendor.Shared
and Sitegeist.Chantalle
as they are only needed to kickstart
further site-packages from now on. The package Sitegeist.Chantalle
is included here as it implements the adopt command for the previous task:
ddev composer remove vendor/site ddev composer remove vendor/wheelinventor ddev composer remove vendor/supportwheelinventor ddev composer remove vendor/shared ddev composer remove sitegeist/chantalle
Altenatively you may require an existing site-package like Neos.Demo via composer:
composer-require neos/demo
Initialize the project git repository
The following commands will initialize the git repository, setup git-hooks and perform composer and yarn install.
git init make install
Import site-content or create a new site
ddev flow site:import --package-key __your_site_package_key__
Running the site locally
You can start a development server via:
make up
Clone project data
You can clone your project data directly with make. This command shows up the list and ask for the preset.
make clone
or type the preset directly:
make clone