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.

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

Quicker quick start #304

Closed
fulldecent opened this issue Sep 27, 2024 · 3 comments
Closed

Quicker quick start #304

fulldecent opened this issue Sep 27, 2024 · 3 comments

Comments

@fulldecent
Copy link
Contributor

fulldecent commented Sep 27, 2024

I believe that every Moodle plugin project should include instructions to test their module in a live, local Moodle environment.

I also think that moodle-docker is the canonical Docker repo to use for developing and testing Moodle plugins.

This means that all the instructions at https://github.com/moodlehq/moodle-docker?tab=readme-ov-file#quick-start are incorporated into the development of every plugin.

That's a lot of instructions!


I hope that the setup for moodle-docker can be simplified greatly. Ultimately this can be whittled down to the single command:

cd $SOME_DIR
docker-compose up

This will load check out Moodle, create directories as needed, and run everything.

If additional configuration is required, like MOODLE_DOCKER_WWWROOT MOODLE_DOCKER_DB or whatever is in the shell script, those can be handled as additional options.

@serafdev
Copy link

serafdev commented Oct 4, 2024

I would like even quicker, just a docker compose up -d without even doing cd

@fulldecent
Copy link
Contributor Author

That's good!


Here is my current progress here:

https://github.com/fulldecent/moodle-local_plugin_template/blob/00766d33b6ac9d1c80612b0475ecff983032d692/README.md#quick-start-playground

I think this is the current best practice for testing a plugin and these instructions should be included in the README of every plugin's repo.

@paulholden
Copy link
Member

See #249 for .env support (which would be the "Quicker quick start") - the rest of this request appears to be asking for support for your own plugin, so I'll close this one

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants