Skip to content

Commit c6bbd6b

Browse files
authored
Update README.md
1 parent e8828c4 commit c6bbd6b

File tree

1 file changed

+72
-15
lines changed

1 file changed

+72
-15
lines changed

README.md

Lines changed: 72 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,87 @@
1-
![Gitpod for Magento 2 Development](http://www.develodesign.co.uk/gitpod.png)
2-
[Click here to Learn more about Gitpod for Magento 2 on our Course](https://develo.teachable.com/p/mastering-gitpod-for-magento-2-development)
1+
# Gitpod Magento 2 Cloud Development Environment
32

4-
# Magento 2 Gitpod Cloud Development Environment
3+
## Introduction
4+
This repository serves as a springboard for developers to launch fully-configured Magento 2 development environments using Gitpod. With the focus on convenience and efficiency, it facilitates seamless Magento 2 development workflows in the cloud.
5+
<br><br>
56

6-
This repository contains a Gitpod configuration for a Magento 2 cloud development environment.
7+
## Getting Started
8+
To begin using this environment, you need to have a Gitpod account. Once you have your account set up, fork this repository and launch your workspace with a single click. Gitpod will read the configuration files and set up the environment accordingly.
9+
<br><br>
710

8-
The goal is to have a simple way of creating different configuraitons for Magento 2 dev environments, that begin quickly and require no further input to being using.
11+
## Features
12+
**Pre-configured Magento 2:** A ready-to-code Magento 2 environment set up with sensible defaults to start coding immediately.
913

10-
11-
# Getting Started
12-
Once the Gitpod browser extension is installed [Download Extension](https://www.gitpod.io/docs/browser-extension), click the Gitpod button in Github to get started with a blank Magento 2 enviroment.
14+
**Development Toolkit:** Includes ready to go tools that make you a super powered developer.
1315

14-
# Configuring Magento and the Server Env Versions
15-
All configuration options including Magento versions and Admin login are found here [.gitpod.Dockerfile](https://github.com/develodesign/magento-gitpod/blob/main/.gitpod.Dockerfile).
16+
**Automated Setups:** On every Gitpod workspace launch, the environment automatically configures itself, eliminating the need for manual setup.
1617

17-
# Use in an Existing Project
18-
- Copy the ```Gitpod``` folder, ```gitpod.yml``` and ```.gitpod.Dockerfile``` files to an existing Magento 2 repository to use on your own project.
18+
**Cloud-based Development:** Work from anywhere, on any machine, without the need to install and maintain a local development stack.
19+
<br><br>
1920

20-
# Installing an existing database
21+
## Benefits of a Cloud Development Environment
22+
23+
**Portability:** Whether you’re at home, in the office, or on the go, your development environment is accessible from any device with an internet connection.
24+
25+
**Consistency:** Every member of the team works within a standardized environment, reducing "it works on my machine" issues and streamlining collaboration.
26+
27+
**Scalability:** Resources can be scaled according to the project's demands without the need for physical hardware upgrades.
28+
29+
**Security:** With all code and data stored in the cloud, the security is centralized and can be managed more effectively than on individual local machines.
30+
31+
**Cost-Efficiency:** Reduce expenses on hardware and energy. Pay only for the resources you use, when you use them.
32+
33+
## Zero config required development tools
34+
**MailPit :**
35+
email catching and debugging
36+
37+
**Tab nine :**
38+
A.I autocomplete code tool
39+
40+
**Cypress :**
41+
A great testing tool
42+
43+
**Xdebug :**
44+
PHP debugger ready to go
45+
<br><br>
46+
47+
## How to Use
48+
**Fork the Repository:**
49+
Fork this repository to your GitHub account.
50+
51+
**Open in Gitpod:**
52+
Click the Gitpod button on your forked repository to launch the development environment.
53+
54+
**Start Coding:**
55+
Once the environment is ready, you can start coding immediately with Magento 2.
56+
<br><br>
57+
58+
## Customization
59+
To tailor the environment to your needs, you can modify the provided .gitpod.yml and .gitpod.Dockerfile configuration files. Add or remove services, extensions, and configurations as necessary for your project.
60+
<br><br>
61+
62+
## Support
63+
If you encounter any issues or have questions, please open an issue in the repository, and we'll address it as soon as possible.
64+
<br><br>
65+
66+
## Contribution
67+
Contributions are welcome! If you have suggestions or improvements, feel free to make a pull request.
68+
<br><br>
69+
70+
Jumpstart your Magento 2 development with the efficiency and flexibility of a cloud-based environment. Try it now and experience a streamlined development workflow that lets you focus on coding, not configuration.
71+
72+
## Learn More
73+
[Click here to Learn more about Gitpod for Magento 2 on our Free Teachable Course](https://develo.teachable.com/p/mastering-gitpod-for-magento-2-development)
74+
<br><br>
75+
76+
## Installing an existing database
2177
- Uncomment and complete the code [here](https://github.com/develodesign/magento-gitpod/blob/0880b246b9392d07d3655c740ba2f59376fd68f2/gitpod/m2-install.sh#L28) to have the script import an existing Magento 2 database.
2278
- Replace ```staging-domain.com``` in the file with your Magento 2 url, this will be replaced with the current gitpod workspace URL before import.
2379
- Compress your .sql file and place into the gitpod folder as ```magento-db.sql.zip```
2480
- Set INSTALL_MAGENTO = No in the [.gitpod.Dockerfile](https://github.com/develodesign/magento-gitpod/blob/main/.gitpod.Dockerfile)
2581

82+
<br><br>
2683

27-
# Road Map
84+
## Road Map
2885
- [x] Run Magento fully installed on load
2986
- [x] Have no files marked as changed in GIT.
3087
- [x] Install Magento SQL once on first load, delete flag to reinstall
@@ -34,7 +91,7 @@ All configuration options including Magento versions and Admin login are found h
3491
- [x] Magento 2.4.6 and PHP8.2 support
3592
- [x] Add additional SQL and config updates, Magento config for SMTP details, Algolia indexing etc.
3693
- [x] Accept values for Magento configuration through Gitpod ENV
37-
94+
<br><br>
3895

3996
# Credit
4097
Based on the original Gitpod config produced by https://github.com/nemke82/magento2gitpod

0 commit comments

Comments
 (0)