more information on setting up a dev environment

luceos

run: git pull upstream master - you now pulled in the latest changes from the flarum core repository
run: composer install --prefer-dist in the same flarum/core directory
go back one directory (cd ..) so you're back in the flarum directory, also run composer install --prefer-dist (no need to dumpautoload
go up into core/js and run bower install
go up into forum and run npm install && gulp
go back and up into admin cd ../admin and run those two commands again npm install && gulp
now for the last step you can either (use or reuse a previously generated config), place that in the public directory or generate a new one using the flarum command: cd ../../../ && php flarum install --defaults

luceos

Notes to this procedure:

We use forks to write fixes. In order to do so you need to cd into either the core or the root folder and create a branch. You'll then commit your fixes and push to that branch of your own repository. On github you'll then see an option to create a pull request to the forked-from repository.
We use upstreams to keep our own repositories to push to, but the upstream to pull updates from flarum from. This way you can keep up to date on the progress of the core developers, while also being able to create new code and pull requests.

@Toby your tutorial worked after all, I guess I missed something with gulp. Also I might not be aware of open issues, but the following popped up during bower installation:

bower mithril#next invalid-meta mithril is missing "main" entry in bower.json
bower mithril#next invalid-meta mithril is missing "ignore" entry in bower.json

luceos

Issues to solve:

no fontawesome; issue is that the fonts are install to public/fonts relative to the flarum/core folder
locale/trans files not copied/installed

Toby

Great work with all of this – sorry about the lack of thorough documentation on our end. I'll make a note to flesh out the docs sometime soon (if @Franz doesn't beat me to it) ... or feel free to send a PR yourself if you like!

For now FontAwesome fonts can just be copied manually, but keep an eye on #335.

luceos locale/trans files not copied/installed

What do you mean by this?

luceos

Created a command line script to run npm install and bower for all installed extensions, place in your extensions directory and run with chmod +x install.sh && install.sh

#!/usr/bin/env bash

REGEX_ADMIN_OR_FORUM='(admin|forum)$'
CURRENT_PATH=${PWD}

for extension in `find . -maxdepth 1 -type d`
do
if [ ${extension} != '.' ]; then
	echo ${extension}
	EXTENSION_PATH=${PWD}
	cd ${extension}
	composer install
	for js in `find ./js -maxdepth 1 -type d`
	do
		if [ ${js} != '.' ] && [[ ${js} =~ $REGEX_ADMIN_OR_FORUM ]]; then
			cd ${js}
			npm install
			if [ -f "bower.json" ]; then
			    bower install
			fi
			if [ -f "Gulpfile.js" ]; then
			    gulp
			fi
			cd ${EXTENSION_PATH}
		fi
	done
	cd ${CURRENT_PATH}
fi
done

luceos

Toby for tags the file locale/en.yml wasn't read in the system. I experienced this after enabling the extension. See my example site http://laravel.today so trans strings were missing on all buttons/information related to tags

luceos

Toby

or feel free to send a PR yourself if you like

Already send in one, but it was fixed while I was committing. At least I'm able to contribute now, I'm thinking about setting up an installer for the steps I described above, unless you beat me to that 😉

Toby

luceos Ah, gotcha. Just opened #412.

Franz

luceos I'll have to update our Vagrant setup script, that should be the best solution...

luceos

Franz I'm not running vagrant 😉 This is all on a cloud machine running ubuntu 14.04 with apache2.

Franz

Updating that will come along with updating the installation scripts, though - so that might help 😉

luceos

Franz so, I have my dev environment ready, upstream pointing to your repo's, origin to my own. Pulled your changes etc.. Ran gulp magic. But I end up with the error:

Uncaught TypeError: this.$(...).sortable is not a function from the following code:

this.$('ol, ul').sortable({ connectWith: 'primary' }).on('sortupdate', function (e, ui) {
          // If we've moved a tag from 'primary' to 'secondary', then we'll update
          // its attributes in our local store so that when we redraw the change
          // will be made.
          if (ui.startparent.is('ol') && ui.endparent.is('ul')) {
            app.store.getById('tags', ui.item.data('id')).pushData({
              attributes: {
                position: null,
                isChild: false
              },
              relationships: { parent: null }
            });
          }

obviously i miss some js requirement, but which one and where do i reload/rerun/regulp it?

luceos

So the problem was related to the missing bower install in the tags/js/admin directory. Will update the install script.

luceos

@Toby you've signed up on my site (https://laravel.today) the mail settings weren't yet configured, I fixed that now and removed your account. Re-send activation mail request 😉