Contents

# Bulb

Bulb is a Rails engine that allows easy displaying and management
of Git repositories.

The aim is to provide a very simple engine that you can integrate
into your personal or organization's website to easily browse your
Git repositories, stylize things as you wish and provide any feature
you would like to attach to your repos.

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'bulb'
```

And then execute:

```bash
$ bundle
```

## Usage

Once installed, you need to generate the needed migrations to
create the tables and migrate your database:

```bash
$ rake bulb:install:migrations
$ rake db:migrate
```

Then, you can mount the engine to whichever path you like:

```ruby
mount Bulb::Engine => "/git"
```

Then your repositories will be available through `/git/:group-slug/:slug`
like `/git/sites/personal`.

To configure where your repositories are stored and who own them, you can
open your `config/application.rb` or any environment-specific file and add
the following:

```ruby
config.bulb.repositories_path = '/srv/git/'
config.bulb.repositories_owner = 'git'
```

Where `git` is a Unix user on your system that must be the owner of the
repository folders.

## License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

Version data entries

2 entries across 2 versions & 1 rubygems

Version	Path
bulb-0.5.0	README.md
bulb-0.4.0	README.md