diff options
| -rw-r--r-- | DEVENV.md | 61 | ||||
| -rw-r--r-- | README.md | 2 |
2 files changed, 62 insertions, 1 deletions
diff --git a/DEVENV.md b/DEVENV.md new file mode 100644 index 00000000000..d66d0d4ca69 --- /dev/null +++ b/DEVENV.md @@ -0,0 +1,61 @@ +## Spin-up a quick nextcloud development instance 🚀 + +### 1) Install the required packages ⛑ + +* [php](https://www.php.net/manual/en/install.php) +* php-gd +* php-sqlite + +--- + +### 2) Edit php.ini file to enable the installed extensions 🧰 + +``` +sudo nano /etc/php/php.ini +``` + +Comment out `extension=gd` and `extension=pdo_sqlite` + +--- + +### 3) Get nextcloud ☁️ + +Clone the server repository: + +``` +git clone https://github.com/nextcloud/server.git +``` + +Update third party modules: + +``` +cd server +``` + +``` +git submodule update --init +``` + +--- + +## 4) Start server 🌐 + +From within the server folder, execute: + +``` + php -S 0.0.0.0:80 +``` + +--- + +## 5) Type 'localhost' in your browser and enjoy contributing! 🥂 🎉 + +--- + +### Install apps 👾 + +\- If you want to install apps, you can directly go into your apps management; + +\- **but** if you want to work on apps development, just clone their git repository into the apps folder in the server folder; + +### Note: this is not an ideal permanent development environment. For a more stable and reliable platform, [please follow these instructions](https://docs.nextcloud.com/server/latest/developer_manual/general/devenv.html))
\ No newline at end of file diff --git a/README.md b/README.md index 8eb799e20d9..8655edb3473 100644 --- a/README.md +++ b/README.md @@ -45,7 +45,7 @@ There are many ways to contribute, of which development is only one! Find out [h ### Development setup 👩💻 -1. 🚀 [Set up your local development environment](https://docs.nextcloud.com/server/latest/developer_manual/general/devenv.html) +1. 🚀 [Set up your local development environment](./DEVENV.md) 2. 🐛 [Pick a good first issue](https://github.com/nextcloud/server/labels/good%20first%20issue) 3. 👩🔧 Create a branch and make your changes. Remember to sign off your commits using `git commit -sm "Your commit message"` 4. ⬆ Create a [pull request](https://opensource.guide/how-to-contribute/#opening-a-pull-request) and `@mention` the people from the issue to review |