TLDR Local Dev Instructions for Fleetio Developers

To get started developing within Fleetio spark, familiarize yourself with these commands:

  • bundle install, gotta install your gem stuff
  • yarn install, gotta install your javascripts
  • spark help, see helpful list of spark commands such as:
  • spark build, builds JS and CSS assets for usage in doc site and fleetio if linked locally
  • spark watch, watches assets to automatically build on change
  • spark server, locally serves the spark site at localhost:3000

And to help while developing in the fleetio codebase:

  • SPARK_LOCAL=true <insert your server command>, use the SPARK_LOCAL env variable to make your fleetio pull local version of spark gem during development. For most this will look like SPARK_LOCAL=true foreman start -f Procfile.dev

Everything above should be enough to get you going, for more questions hit the #spark channel in slack

FleetioSpark

Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file lib/fleetio_spark. To experiment with that code, run bin/console for an interactive prompt.

Installation

Add this line to your application's Gemfile:

gem 'fleetio_spark'

And then execute:

$ bundle

Or install it yourself as:

$ gem install fleetio_spark

Usage

TODO: Write usage instructions here

Development

After checking out the repo, run bin/setup to install dependencies. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/imathis/fleetio_spark. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the FleetioSpark project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.