diff --git a/DistributionPackages/CodeQ.Site/composer.json b/DistributionPackages/CodeQ.Site/composer.json index c24434e..aaf13f5 100644 --- a/DistributionPackages/CodeQ.Site/composer.json +++ b/DistributionPackages/CodeQ.Site/composer.json @@ -28,11 +28,6 @@ "ttree/eelshell": "@dev", "sitegeist/neosguidelines": "^1.1" }, - "autoload": { - "psr-4": { - "CodeQ\\Site\\": "Classes/" - } - }, "extra": { "branch-alias": { "dev-master": "1.0.x-dev" diff --git a/README.md b/README.md index f9eea28..77686ea 100644 --- a/README.md +++ b/README.md @@ -46,35 +46,43 @@ Your local development environment must provide [a webserver like Apache or ngin __Start a new git project__ -1. Clone this repository `git clone git@github.com:code-q-web-factory/Neos-Skeleton.git PROJECTNAME` +1. Clone this repository `git clone git@github.com:code-q-web-factory/Neos-Skeleton.git PROJECT_NAME` 2. Replace the Package name "CodeQ.Site" with your own company name. We recommend to keep ".Site" for all projects to easily copy code from one project to another. + ``` + export REPO_NAME="MyFirstWebsite" + export NEOS_PACKAGE_NAME="YourCompany.Site" + export COMPOSER_PACKAGE_NAME="yourcompany\/site" + cd ${REPO_NAME} + mv DistributionPackages/CodeQ.Site DistributionPackages/${NEOS_PACKAGE_NAME} + find ./DistributionPackages/${NEOS_PACKAGE_NAME} -type f | xargs sed -i '' "s/CodeQ\.Site/${NEOS_PACKAGE_NAME}/g" + find . -type f -name 'composer.json' | xargs sed -i '' "s/codeq\/site/${COMPOSER_PACKAGE_NAME}/g" + ``` 3. Create a new git project on the server of your choice, in our example Github 4. Start the new git project locally and push the initial state ``` - cd PROJECTNAME rm -rf .git && git init - git remote add origin git@github.com:PROJECTNAME.git + git remote add origin git@github.com:${REPO_NAME}.git git fetch - git add . composer install + git add . git commit -m "TASK: Copy from Neos-Skeleton" git push -u origin master ``` __Run the project locallly__ -5. Start your database server. +5. Start your database server and create a new database with the charset 'utf8'. 6. Start the local server in the terminal: ``` ./flow server:run ``` -7. Setup the database configuration and initial content at [http://127.0.0.1:8081/setup](http://127.0.0.1:8081/setup), there import the initial content from the package CodeQ.Site. +7. Setup the database configuration at [http://127.0.0.1:8081/setup](http://127.0.0.1:8081/setup) and import the initial content from your package. __Configure your project__ 8. Configure the Google Analytics tracking code in [Production/Settings.yaml](DistributionPackages/CodeQ.Site/Configuration/Production/Settings.yaml) in the format `UA-XXXXXXXX-X` 9. German is the default language, you can adopt it in [Settings.Language.yaml](DistributionPackages/CodeQ.Site/Configuration/Settings.Language.yaml) -10. In the Neos administration create a new page with the url path segment "404", this page will be used every time a page couldn't be found. +10. In the Neos administration your can find a page "Page not found", which is shown every time a page couldn't be found. Feel free to add content here. __Start developing__