richard-tirta Goto Github PK

For small-to-mid sized projects - centralize and define:

• development solutions
• best practices
• workflows
• toolsets

• Bundler
• Middleman
• rbenv

From the command line:

$ git clone [email protected]:RayPatterson/project-boilerplate.git; cd project-boilerplate
$ gem install bundler; bundle install; rake mm:s

After the gem bundling is complete,
Middleman will begin running a server and display something like:

middleman server -p 8888
== The Middleman is loading
== LiveReload is waiting for a browser to connect
== The Middleman is standing watch at http://0.0.0.0:8888
== Inspect your site configuration at http://0.0.0.0:8888/__middleman/

Open you broswer to http://localhost:8888 or run:

$ rake browser:chrome

The browser should display "You are using project-boilerplate."

INFO

This will require installing a few things if you want the Favicon Maker and Image Optim extensions to work.

If you don't have Homebrew, God help you. If you do:

$ brew install imagemagick advancecomp gifsicle jhead jpegoptim jpeg optipng pngcrush

Pngout is still in the stone age at the time of writing, so:

1. Click here to download the universal Mac binaries.
2. Unzip and copy the pngout binary to /usr/bin

Now run:

$ rake mm:build:development

A build directory should appear in the project root.

source Contains all source files that are processed and compiled by Middleman into the build directory.

data Contains YAML files used to define parameters for Rake tasks and Middleman template data.

lib Contains all Rake tasks. Some can be used for any project, however some have very specific uses and require configuration.

INFO

######Important

• .gitignore - If you find some of your files or folders are not being committed, check this file to see if they are being ignored. Chances are you don't need to version them.
• .ruby-version - Specifies Ruby version for rbenv (recommended) or RVM (legacy).
• Gemfile - Used by Bundler to define Ruby gem dependencies. Gemfile.lock is generated from this file and should not be edited directly.
• config.rb - The Middleman configuration file. Activates and configures Middlman extensions.

######Miscellaneous

• Rakefile - Requires all Rake tasks inside lib/tasks folder.
• .editorconfig - Editor config.
• .jsbeautifyrc - For use with jsFormat Sublime Text plugin.
• .rbenv-gemsets - Specifies Gemset name for rbenv Gemset plugin.

######Deprecated

• config.ru - Heroku related Rack middleware configuration that provides basic auth, device detection and redirect functionality.
• .env & Procfile- Heroku related Foreman configurations.

This is a configured Middleman project. The project utilizes MM to "build" or "compile" the code base for deployment. Commands have been wrapped in Rake tasks to target development and production build types.

This system defines a solution for a sequence of async events in which initializes different areas of concern within the project structure. It's currently using Nimble but should be converted to jQuery Promises.

The data/config.yaml file contains some externalized data that is used by Middleman in config.rb, some of the deployment tasks in lib/tasks and can also be read directly into Middleman templates though the data object.

The Middleman config.rb can also be used to pass the values from data/config.yaml into the application templates. An example of this can be seen in source/assets/js/project/config-js where the helper <%= build_version %> is used to assigned the build version ID to a JavaScript variable.

INFO

The relationships between desktop/tablet/mobile apps for each environment are set within the data/config.yaml file.

In both the middleware and client-side soltions, Android tablets are treated the same as Android mobile devices.

If you are deploying to a hosting service such as Heroku that supports Rack middleware, you may use a middleware based solution.

The current solution in place is https://github.com/talison/rack-mobile-detect

There is some additional configuration that can take place within the Rack config config.ru file.

If the redirect needs to rely on JavaScript you may follow these steps:

1. Open source/assets/js/lib/redirect/redirect.js
2. Replace "REDIRECT-URL-{DEVICE}" with the appropriate redirect URL's.
3. Replace "REDIRECT-SEARCH-PATTERN" with the appropriate search patterns.
4. Optionally replace "REDIRECT-URL-IGNORE" if you want to bypass the redirect on specific URL's.
5. If you are running on a local port other than "8888" replace as necessary.
6. Embed this file into the tag of source\index.html.erb.

INFO

The build can be compiled without incrementing the build version Id with the following command:

$ rake mm:build:development

The build can be versioned manually with the following command:

$ rake version:increment

The build will be versioned automatically when compiling a Staging build for release using the following command:

$ rake mm:build:staging

Each build has a version number that is always visible on the client as long as the console object exists.

E.g. Build Version --> v0099

When in testing and production phases, build version Ids can correspond with the names of the released build versions in the issue tracking system.

These associations can be made by the Release Manager.

Once the develop branch has been merged successfully into the master branch, the build can be tagged in with the following command:

$ rake version:tag

In order for the production release tags to make it to the origin (GitHub) repository, you must use the following command:

$ git push origin master --tags

Documentation pending.