Skip to content

Instantly share code, notes, and snippets.

@schulle4u

schulle4u/yellow-dev.md

Last active January 2, 2024 21:07
Show Gist options
  • Star 2 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save schulle4u/d970e9060d47e768f15f37e79611fe24 to your computer and use it in GitHub Desktop.
Save schulle4u/d970e9060d47e768f15f37e79611fe24 to your computer and use it in GitHub Desktop.
Download ZIP
My development environment for Datenstrom yellow
Raw
yellow-dev.md

My local development environment for Datenstrom yellow

This is just my own environment, please don't consider this as an official development guide. Operating systems and software will vary for your own needs. Please consult the internet for any installation help.

What you need

  • Windows 11 Pro, 64 Bit
  • Windows Subsystem for Linux (WSL2) running Debian 12
  • GitHub Desktop

How to setup

Under Windows

  1. Create a project folder for your GitHub repositories, e.g. C:\Users\Username\Documents\GitHub\
  2. In GitHub desktop, clone the official Yellow extensions repository into this folder so that it becomes a subdirectory (should already be the default setting), e.g. C:\users\username\Documents\GitHub\yellow-extensions\.
  3. It is recommended to create individual repositories for each of your extensions. Use yellow-name as a pattern, where name is the name of your extension.

The WSL part

  1. Install PHP. Please check available guides how to do this. I'm using the Sury repository to always have the latest version. To avoid installing the apache web server, install php with fpm support.
  2. Install required PHP modules: sudo apt update && apt install php-curl php-gd php-mbstring php-zip
  3. Install Git: sudo apt update && sudo apt install git
  4. Clone the Datenstrom Yellow repository somewhere in your WSL home directory: git clone https://github.com/datenstrom/yellow.git yellow-dev
  5. As we don't need a configured edit extension in this installation, change into the yellow-dev directory and run: php yellow.php skip installation
  6. Install the publish extension: php yellow.php install publish
  7. In your system/extensions/yellow-system.ini, add/change PublishSourceCodeDirectory to your GitHub projects folder, e.g.: PublishSourceCodeDirectory: /mnt/c/users/Username/Documents/Github/
  8. Now you can follow the remaining guidelines given in the publish documentation to upload and publish your extensions.

Happy coding! 🙂

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment