Note:

If you want to create a new page for developers, you should create it on the Moodle Developer Resource site.

Setting up development environment: Difference between revisions

From MoodleDocs
No edit summary
(Update migration status and path)
 
(18 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 10: Line 11:
** [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]
** General: [https://docs.moodle.org/en/Category:Installation Category:Installation]
* [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])


== Dabatase ==
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 23: Line 26:
** [https://www.adminer.org/ Adminer]
** [https://www.adminer.org/ Adminer]


== Moodle Development Kit (MDK) ==
== 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)
Only for Linux and MacOS (not available for Windows)
* [https://github.com/FMCorz/mdk#user-content-for-development Setup]
* [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:
** Sample to create some instances (both based on master, first using PostgreSQL and second MySQL:
<code php>
<syntaxhighlight lang="php">
mdk create --install --engine pgsql --run mindev users makecourse
mdk create --install --engine pgsql --run mindev users makecourse
mdk create --install --engine mysqli --run mindev users makecourse -n stable_master-mysql
mdk create --install --engine mysqli --run mindev users makecourse -n stable_master-mysql
</code>
</syntaxhighlight>
* [[Running_acceptance_test#2._Set_up_Selenium | Behat]]
* [[Running_acceptance_test#2._Set_up_Selenium | Behat]]
** JRE
** JRE
** GoogleChrome driver (Firefox stopped working)
** GoogleChrome driver (Firefox stopped working)
=== Docker ===
* https://github.com/moodlehq/moodle-docker


== IDE ==
== IDE ==
Line 40: Line 52:
* [[Setting_up_Eclipse | Eclipse]]
* [[Setting_up_Eclipse | Eclipse]]
* [[Setting_up_Netbeans | Netbeans]]
* [[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

More information: Category:Installation

Database

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...)