An open API service indexing awesome lists of open source software.

https://github.com/fog/fog-local

Module for the 'fog' gem to support local filesystem storage
https://github.com/fog/fog-local

Last synced: about 1 year ago
JSON representation

Module for the 'fog' gem to support local filesystem storage

Awesome Lists containing this project

README

          

# Fog::Local

![Gem Version](https://badge.fury.io/rb/fog-local.svg)
[![Build Status](https://github.com/fog/fog-local/actions/workflows/ci.yml/badge.svg)](https://github.com/fog/fog-local/actions/workflows/ci.yml)

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'fog-local'
```

And then execute:

$ bundle

Or install it yourself as:

$ gem install fog-local

## Usage

Initialise a `Fog::Local::Storage` object:

```ruby
storage = Fog::Local::Storage.new(local_root: '~/fog')
```

This can then be used like any other [Fog storage](https://fog.github.io/storage/).

```ruby
directory = storage.directories.create(key: 'data')
directory.files.create(body: 'Hello World!', key: 'hello_world.txt')
```

## Contributing

1. Fork it ( https://github.com/fog/fog-local/fork)
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request