Totem::Lodestar

A gem built to include base functionality for markdown based documentation rails app.

Installation

Hey!! This process should be done on a fresh installation of Rails 5.0+, some files will be force replaced and data may be lost to default values!

Add this line to your application's Gemfile

gem 'totem-lodestar', git: 'https://github.com/sixthedge/totem-lodestar', branch: 'master'

Install the gem with

$ bundle install

Generate and inject engine requirements with

$ rails g totem:lodestar:install

After the install, configure your database settings in app/config/database.yml these will be defaulted to values that may not be valid in your environment.

The engine requires Postgresql to be the database of the application at this time.

Migrate the database

$ rails db:drop db:create db:migrate

Before this last step you must have the documents directory added currently it must be app/public/documents/ within the documents/ directory there must be at least one version denoted. (ex: 1.0.0)

Generate Guides

$ rails totem:lodestar:generate

Generate API

$ rails totem:lodestar:api[build]

// If you want to build off your local directories use
$ rails totem:lodestar:api[build,local]

Deploy

To incorporate Travis CI to the deploy workflow you will need heroku cli as well as the travis cli.

Generate your secure key

travis encrypt $(heroku auth:token) --add deploy.api_key

Then add this generated secure key to the .travis.yml

deploy:
  provider: heroku
  api_key:
    secure: $SECURE_KEY
  on: master

License

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