elbowspaceuk/origin-engine

A site manager for local development

dev-develop 2021-11-23 12:22 UTC

Requires

• php: ^7.4|^8.0
• ext-json: *
• ext-pcntl: *
• czproject/git-php: ^3.18
• guzzlehttp/guzzle: ^7.0.1
• http-interop/http-factory-guzzle: ^1.0
• illuminate/database: ^8.0
• intonate/tinker-zero: ^1.2
• knplabs/github-api: ^3.0
• laravel-zero/framework: ^8.4
• laravel-zero/phar-updater: ^1.1
• symfony/filesystem: ^5.2

MIT

• Toby Twigger
• Aidan Laycock

README

Your local development environment in a single command
Explore the docs »

Developer Documentation · Report Bug · Request Feature

Table of Contents

• About the Project
• Getting Started
• Contributing
• License
• Contact

⚠️ This project is in active development. You're welcome to use it, but it's likely to change before a stable release.

About The Project

Origin is a customisable local development tool for Windows WSL2, macOS & Linux. It can help you manage everything from locally running your apps and working on their dependencies to managing your git workflow and ticketing system. It works predominantly with PHP based applications, using composer for dependency management.

Implemented features

• Local site management. Spin up a new instance of any site with a single command.
• Local dependency tools. Quickly clone and symlink a dependency using composer, making working on dependencies seamless.
• Create and publish code stubs to quickly scaffold repetitive structures
• Work on many branches in the same local site, and easily switch between features.

Getting Started

For now, contact us for information on how to build your own. We will be writing our developer documentation shortly which will cover how to use Origin for your own site.

We will also be releasing a project which will allow you to run your site with standard docker environments (such as Laravel Sail) in the near future.

Contributing

Contributions are what make the open source community such an amazing place to learn, be inspired, and create. Any contributions you make are greatly appreciated.

1. Create an issue to notify us of your planned changes
2. Fork the Project
3. Create your Feature Branch (git checkout -b feature/AmazingFeature)
4. Commit your Changes (git commit -m 'Add some AmazingFeature')
5. Push to the Branch (git push origin feature/AmazingFeature)
6. Open a Pull Request to the Development Branch

See CONTRIBUTING for more information.

License

Distributed under the GPL-3.0 License. See LICENSE for more information.

Contact

ElbowSpace UK - https://elbowspace.co.uk/ Toby Twigger - [e-mail]

Project Link: https://github.com/ElbowSpaceUK/origin-engine