Setting up development environment: Difference between revisions
From MoodleDocs
(Created page with "This is a quick guide which contains all the tools you'll need to configure your development environment: == Git == * Git_for_developers#Installing_Git_on_your_computer|Ins...") |
Dev Docs Bot (talk | contribs) (Update migration status and path) |
||
| (19 intermediate revisions by 9 users not shown) | |||
| Line 1: | Line 1: | ||
{{Template:Migrated|newDocId=/general/development/gettingstarted}} | |||
This is a quick guide which contains all the tools you'll need to configure your development environment: | This is a quick guide which contains all the tools you'll need to configure your development environment: | ||
| Line 5: | Line 6: | ||
* [[Git_for_developers#Setting-up the public repository|Setting-up GitHub]] | * [[Git_for_developers#Setting-up the public repository|Setting-up GitHub]] | ||
== Apache + PHP== | == Apache + PHP == | ||
* Depending on your computer's OS: | * Depending on your computer's OS: | ||
** [https://docs.moodle.org/en/Installing_Moodle_on_Debian_based_distributions#Step_1:_Install_required_packages Debian] | ** [https://docs.moodle.org/en/Installing_Moodle_on_Debian_based_distributions#Step_1:_Install_required_packages Debian] | ||
** [https://docs.moodle.org/en/Installation_on_OS_X OS X] | ** [https://docs.moodle.org/en/Installation_on_OS_X OS X] | ||
** [https://docs.moodle.org/en/Windows_installation Windows]: [https://docs.moodle.org/en/Installing_Apache_on_Windows Apache] + [https://docs.moodle.org/en/Installing_PHP_on_Windows PHP] | ** [https://docs.moodle.org/en/Windows_installation Windows]: [https://docs.moodle.org/en/Installing_Apache_on_Windows Apache] + [https://docs.moodle.org/en/Installing_PHP_on_Windows PHP] | ||
* | * [https://docs.moodle.org/en/PHP#PHP_Extensions_and_libraries Extensions and libraries] | ||
* Enable SSL for Apache ([https://docs.moodle.org/en/Transitioning_to_HTTPS Transitioning to HTTPS]) | * Enable SSL for Apache ([https://docs.moodle.org/en/Transitioning_to_HTTPS Transitioning to HTTPS]) | ||
== | More information: [https://docs.moodle.org/en/Category:Installation Category:Installation] | ||
== Database == | |||
* Server: | * Server: | ||
** [https://docs.moodle.org/en/PostgreSQL PostgreSQL] (recommended) | ** [https://docs.moodle.org/en/PostgreSQL PostgreSQL] (recommended) | ||
| Line 22: | Line 25: | ||
* Client: | * Client: | ||
** [https://www.adminer.org/ Adminer] | ** [https://www.adminer.org/ Adminer] | ||
== Moodle == | |||
=== Manual installation === | |||
* [https://docs.moodle.org/en/Installation_quick_guide Quick guide] | |||
=== Moodle Development Kit (MDK) === | |||
Only for Linux and MacOS (not available for Windows) | |||
* [https://github.com/FMCorz/mdk#user-content-for-development Setup] | |||
** Sample to create some instances (both based on master, first using PostgreSQL and second MySQL: | |||
<syntaxhighlight lang="php"> | |||
mdk create --install --engine pgsql --run mindev users makecourse | |||
mdk create --install --engine mysqli --run mindev users makecourse -n stable_master-mysql | |||
</syntaxhighlight> | |||
* [[Running_acceptance_test#2._Set_up_Selenium | Behat]] | |||
** JRE | |||
** GoogleChrome driver (Firefox stopped working) | |||
=== Docker === | |||
* https://github.com/moodlehq/moodle-docker | |||
== IDE == | |||
* [[Setting_up_Sublime2 | Sublime]] | |||
* [[Setting_up_PhpStorm | PhpStorm]] | |||
* [[Setting_up_Eclipse | Eclipse]] | |||
* [[Setting_up_Netbeans | Netbeans]] | |||
* [[Setting up ViM | ViM]] | |||
== COMMAND LINE == | |||
To view logs in real time on linux based machines you can use at the command line : # tail - f | |||
Example: # tail -f /var/log/apache2/error.log | |||
By viewing logs in real time you will find it easier to correlate actions and errors. | |||
== Other tools == | |||
* [[Grunt#Install_grunt | Grunt]] | |||
* [https://ngrok.com/download Ngrok], for getting your dev/private site publicly available (for sharing, for testing various integrations requiring public site, SSL or no...) | |||
** Use [https://ngrok.com/docs#authtoken authtoken] for better experience | |||
** [https://gist.github.com/andrewnicols/a338c43feca0a87a60248b8097de2ef5 MDK integration] | |||
[[Category:Developer tools|Development environment]] | [[Category:Developer tools|Development environment]] | ||
Latest revision as of 13:44, 17 August 2022
| Important:
This content of this page has been updated and migrated to the new Moodle Developer Resources. The information contained on the page should no longer be seen up-to-date. Why not view this page on the new site and help us to migrate more content to the new site! |
This is a quick guide which contains all the tools you'll need to configure your development environment:
Git
Apache + PHP
- Depending on your computer's OS:
- Extensions and libraries
- Enable SSL for Apache (Transitioning to HTTPS)
More information: Category:Installation
Database
- Server:
- PostgreSQL (recommended)
- MariaDB (recommended)
- MySQL
- MSSQL
- Oracle (not recommended)
- Client:
Moodle
Manual installation
Moodle Development Kit (MDK)
Only for Linux and MacOS (not available for Windows)
- Setup
- Sample to create some instances (both based on master, first using PostgreSQL and second MySQL:
mdk create --install --engine pgsql --run mindev users makecourse
mdk create --install --engine mysqli --run mindev users makecourse -n stable_master-mysql
- Behat
- JRE
- GoogleChrome driver (Firefox stopped working)
Docker
IDE
COMMAND LINE
To view logs in real time on linux based machines you can use at the command line : # tail - f
Example: # tail -f /var/log/apache2/error.log
By viewing logs in real time you will find it easier to correlate actions and errors.
Other tools
- Grunt
- Ngrok, for getting your dev/private site publicly available (for sharing, for testing various integrations requiring public site, SSL or no...)
- Use authtoken for better experience
- MDK integration
