Setting up wpframe

Starting a new wpframe project is easy, if you follow the right steps.

NOTE: We have a very much in beta bootstrap script that will accomplish many of these steps for you. USE AT YOUR OWN DISCRETION. If it breaks things, WE ARE NOT RESPONSIBLE.

If you use that script, you can totally ignore steps 1.1-1.9, 2.1, and 2.4 below. If you like it, let us know, and we'll keep working on making it even better.

Part 1: Get the files

1. Create a new Git repo
2. Add a file to it (any file, as long as its filename doesn't conflict with any of the files in wpframe)
3. Make a commit!
4. git remote add wpframe git://github.com/vanpattenmedia/wpframe.git
5. git fetch wpframe
6. git merge --squash wpframe/master
7. git submodule update --init
8. git commit -m 'Added wpframe'
9. bundle install
10. Yay! You've got the files and the gems!

Part 2: The configuration

1. In project-root/config/, rename project.example.yml, database.example.yml, assets.example.yml and s3.example.yml removing the .example bit.
2. Fill in the appropriate information in each of these files. (If you don't have a git repo URL yet, that's okay, just make sure you remember to add it before you deploy).
3. If you don't want S3 support, remove it by deleting the s3.yml file entirely, and removing the appropriate line from the nginx config.
4. Update the last few lines in .gitignore to reference the appropriate theme path.

Part 3: Ready for lift-off

1. Run vagrant status to make sure you're error free. If you still have errors at this point, file an issue and let us help you figure out why (be sure to include a copy of the error).
2. If you get a "not yet created" message, you can proceed. Run vagrant up.
3. Once Vagrant finishes successfully, edit the Vagrantfile. Move the comment on lines 48 so line 47 is commented out instead, and line 48 is uncommented.
4. Run vagrant reload.
5. You should be all set! Visit http://dev.[your-url-here]/wp/wp-admin/ to begin the installation.

We'll have documentation on how to deploy coming in the next few weeks.