Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update README.md #40

Merged
merged 1 commit into from
Nov 3, 2023
Merged

Update README.md #40

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 31 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,41 @@
# Veyoze - Beta version ⚡️ 🛠️

Veyoze is a command-line interface (CLI) tool designed to automate the setup and deployment of preview environments for web applications. It's optimized for creating PR preview environments for Laravel, Nuxt.js, Next.js, and other web applications deployable to Laravel Forge.
![logo-background-blue-sky-small](https://github.com/mehrancodes/veyoze/assets/7046255/2727ce3d-31c4-4a97-bafc-e461706ff219)

## Why Veyoze?
## Velocity, Efficiency, Yield - Optimize Your Zone of Engineering

- **Swift Deployment**: Deploy environments swiftly as soon as your PR is ready.
- **Automatic Cleanup**: Ensures no remnants of test environments after PRs are merged or closed.
- **Streamlined Workflow**: Efficiently manage multiple environments, ensuring everyone has their space when needed.
In today's fast-paced software development world, the ability to quickly and efficiently test new features is a game-changer for teams aiming to maintain a competitive edge. Preview Environments, also known as Ephemeral Environments, serve as the critical testing grounds for new features, bug fixes, and updates before they are integrated into the main codebase. These environments are crafted on-demand to validate specific git branches, providing a transient yet powerful platform for thorough pre-merge testing.

`"Don't merge until you preview" - with Veyoze, ensure that excellence is the standard, not the exception.`

### The Challenge

While Preview Environments are indispensable in modern DevOps, their setup and maintenance pose a significant challenge. Traditionally, the creation of these environments has been a manual, time-consuming task, often requiring complex orchestration of resources. The process can introduce delays in testing, bottlenecks in deployment, and ultimately hinders the development velocity. Moreover, maintaining the lifecycle of these environments in sync with pull requests (PRs) or merge requests (MRs) demands constant attention and can strain the resources of any software team.

### The Veyoze Solution

Enter Veyoze, the CLI tool designed to seamlessly automate the provisioning of Preview Environments behind the scenes of Laravel Forge Server Manager. Veyoze stands at the forefront of DevOps innovation, offering a streamlined process to generate and manage ephemeral environments effectively. With Veyoze, the creation, updating, and deletion of Preview Environments are triggered automatically in response to PRs or MRs, mirroring the lifecycle of the code changes they represent.

#### How Veyoze Enhances Development Workflows:

- **Automated Provisioning**: Veyoze automates the setup of Preview Environments, enabling your team to focus on building and testing rather than configuration and deployment.
- **Speed and Efficiency**: By reducing the time required to test new features, Veyoze empowers teams to increase their development velocity significantly.
- **Quality Assurance**: Veyoze's pre-merge testing capabilities ensure that every feature is rigorously evaluated in a production-like setting, minimizing the risk of post-merge issues.
- **Scalability**: With Veyoze, teams can scale their testing efforts without a corresponding increase in overhead or complexity.
- **Cross-Functional Collaboration**: By providing isolated environments for each feature, Veyoze facilitates better collaboration across developers, testers, product teams, and stakeholders.
- **Automatic Cleanup**: Veyoze ensures no remnants of test environments after PRs are merged or closed.

### Embracing the "Shift Left" Philosophy

Veyoze embodies the principle of "shifting left" in the software development lifecycle. By shifting testing to the earliest stages possible, Veyoze acts as a quality gate, ensuring that only the most robust features reach your main branch. This proactive approach to quality assurance aligns with the DevOps philosophy of continuous integration and delivery, setting a new standard for code review and quality control.

### The Future of DevOps

As the demand for faster and more reliable deployment cycles grows, tools like Veyoze represent the next step in the evolution of DevOps. It's not just about bringing Web Applications, or APIs into the age of real-time previewing; it's about transforming the entire development process into a more efficient, effective, and error-free journey. With Veyoze, experience the "holy grail" of DevOps, where every pull request paves the way for a smoother, faster, and more secure path to production.

---


## Table of Contents

- [Requirements](#requirements)
Expand Down