The Perfect Neos Project Setup
0 likes420 views
The document discusses best practices for setting up a Neos project, emphasizing that there are no absolute solutions, only context-specific ones. It covers project management, development practices, environment tools, and managing dependencies, advocating for an agile approach and the use of modern technology. Additionally, it highlights the importance of automation, configuration management, and choosing appropriate hosting options.
The Perfect Neos Project Setup
- 1. The Perfect Neos Project Setup
- 4. The Perfect Neos Project Setup
- 5. The Best Neos Project Setup
- 6. A Good Neos Project Setup
- 7. What I Consider A Good Neos Project Setup
- 8. Disclaimer The term "best practice" along with "perfect" is very misleading. There is never the best solution, only a solution that is the best fit in a given situation. Keep your brain moving, question what you have and try something new every now and then. Take everything you are going to hear as something to think about, never as a rule. There is no silver bullet.
- 10. Content First
- 11. Who do we want to reach? What are their goals? What do we need to make reaching those goals possible?
- 12. Create customised content types. No more unstructured blobs of text!
- 13. Adopt an agile working mode
- 14. Some truths Doing development in sprints is not SCRUM. Kanban does not magically finish your project. Not giving a fixed price (or even an estimate) to your client might be hard. But spending days or even weeks to come up with a plan that will inevitably change anyway would be waste.
- 15. Get your project management right, so you can focus on the following things…
- 17. Know your docs: manual, references, API
- 18. flowframework RTD Flow Requirements, Installation, Configuration
- 19. Neos references RTD Flow references Neos references
- 20. neos.github.io
- 22. Settings.yaml
- 26. Stay focused
- 27. Implement only what you need. Don't use a package you only need 10% of.
- 28. An example is not using Neos.NodeTypes
- 29. Write tests
- 32. Do the dishes
- 37. But… eventually you must understand the tools you use.
- 38. Think about Fusion. It seems intimidating at first, then you start to get the hang of it. And think "Ah, that's how it works!” Except it doesn’t. And then things start to feel awkward.
- 39. Keep learning. Adopt new things. Question your own best practice. Take the time, it's worth it.
- 41. Tools
- 42. Developers being able to chose their tools are happier. Let me choose some tools for you…
- 43. vi vs. emacs
- 44. IDE vs. Editor
- 45. Use an IDE
- 48. Neos plugin by Christian Vette https://github.com/cvette/intellij-neos Fluid plugin by Stefan Galinski https://www.sgalinski.de/typo3-produkte-webentwicklung/typo3-fluid-phpstorm-intellij/
- 49. ZSH
- 50. Oh-My-ZSH and the Flow Framework Helper
- 51. flow helper video
- 53. VCS
- 55. Using a version control system is not optional.
- 56. Technology
- 57. Use the newest version of PHP
- 59. Stay up-to-date
- 60. An update a day, keeps the downtime away
- 61. Check security Consider using a service like Symfony Security Monitoring or implement something using the SensioLabs Security Checker or roave/security- advisories.
- 63. Elasticsearch You Know, for Search
- 64. PostgreSQL Can roll back DDL
- 65. Technologies like these can add a lot of value to a project and knowing them allows to apply them when needed.
- 66. Works on my machine
- 67. Running things locally For ages all I had was a local setup of Apache with mod_php and name- based virtual hosting, combined with dnsmasq.
- 68. Just clone any Flow-based project into a directory and it's available through the web server. 🙂
- 69. Must switch globally between PHP versions if needed, every project has the same environment (PHP modules, settings, …), specific tools a project needs would need to be installed on my machine, … 🙁
- 71. With Docker every project can be run in an environment that can closely match the production environment.
- 72. Docker Compose provides a way to define the needed environment using a simple YAML file.
- 77. Make yourself comfortable. It will make you more productive.
- 80. Composer
- 82. Composercat
- 85. semver checker
- 86. semver.mwl.be
- 87. Add composer.lock to version control!
- 88. composer install is different from composer update
- 93. Repository of test/a Repository of test/b Repository of test/distribution Need to commit in three repositories Must update composer.lock after every change to test/a and test/b
- 94. Repository of test/b Repository of test/distribution and test/a Need to commit in two repositories; must update composer.lock after every change to test/b
- 95. Repository of test/distribution and test/a and test/b Need to commit in one repositories Must update composer.lock only after changes to dependencies in test/a or test/b
- 96. • Use path repository for composer • Exclude source folder from IDE • Ignore Packages in VCS • Composer will “install” via symbolic links • Dependencies are resolved as expected • One repository to rule them all
- 98. composer create-project neos/splash This is still work in progress, but hopefully useable soon…
- 99. Dependencies are not a necessary evil, but an important part of your project
- 102. Application context
- 103. Application contexts (can) have a hierarchy
- 104. Development Staging Live Development Production/Staging Production/Live
- 108. 😱
- 110. Configuration is code, treat it accordingly
- 111. Hosting & Deployment
- 112. Automate deployment Surf – Deployer
- 113. Automate automation Jenkins – Travis CI – GitLab CI – Codeship – CircleCI
- 114. Hosting options
- 115. simple
- 116. simple uberspace
- 117. managed
- 119. complex
- 120. complex Digital Ocean – Docker – Kubernetes
- 121. nightmare
- 122. You have a managed server, but the hoster is inflexible. You must not change server settings yourself, but the admin is in a meeting. No access to log files, but the support sends the logs except the interesting line at the end. SSH is possible, but permissions don’t match. You need PHP 7, but are stuck at version 5.3, because of other customers on the same server. Every developer at some point in history
- 123. Hosting options