Geko

Appearance

Contributing to Geko ​

First off, thank you for considering contributing to Geko! It's people like you who make this tool better for everyone.

By participating in this project, you agree to abide by our Code of Conduct.

🚀 How Can I Contribute? ​

Reporting Bugs ​

For issues we are using GitHub issues

You can create issue for each component:

Pull Requests ​

For PR style details can be found in the Editing section.

🛠 Development Setup ​

Geko ​

  1. Clone the Geko repo: https://github.com/geko-tech/geko
  2. Open the project (it is recommended to open it via terminal using the xed . command to ensure environment variables are loaded correctly).
  3. Select the Geko target.
  4. In the Scheme settings, in Run action, under Options find Working Directory field, set the path to the project you will be generating with Geko.

Debug ​

To debug, you can use your own projects or the ready-made fixtures located in the fixtures/ folder.

Fixtures are pre-configured demo projects in various setups used for debugging and testing.

To debug using a specific fixture, go to Scheme > Run Action > Options > Working Directory and set the path to that fixture.

Debug commands ​

To debug a certain function you need to set an argument. A list of all arguments is available when running without arguments. For assistance and help, use the option -h.

To set an argument go to Scheme > Run Action > Arguments > Arguments Passed on launch.

For example: build

FAQ ​

  1. Q: How do I run commands from Xcode?

    A: In the Scheme settings, under Arguments Passed On Launch, enter your startup arguments and run the project.

  2. Q: The run failed with an invalid byte sequence in US-ASCII error on launch

    A: In the Scheme settings, go to Arguments > Environment Variables and add LANG with the value en_US.UTF-8.

Desktop ​

  1. Clone Geko repo https://github.com/geko-tech/geko
  2. Navigate to the geko/GekoDesktop folder.
  3. Install xcodegen if needed brew install xcodegen
  4. Run xcodegen generate in the project folder.
  5. Open GekoDesktop.xcodeproj
ProjectDescription ​
  1. Clone ProjectDescription repo https://github.com/geko-tech/project-description
  2. Open the project (it is recommended to open it via terminal using the xed . command to ensure environment variables are loaded correctly).
GekoPlugins ​

TBD

💬 Questions? ​

Feel free to open an issue or join our Team.