https://github.com/tcd/schemagic

✨
https://github.com/tcd/schemagic

Last synced: 16 days ago
JSON representation

✨

• Host: GitHub
• URL: https://github.com/tcd/schemagic
• Owner: tcd
• License: mit
• Created: 2022-02-26T17:18:06.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2022-03-05T17:55:24.000Z (over 4 years ago)
• Last Synced: 2025-01-03T08:14:24.195Z (over 1 year ago)
• Language: Ruby
• Homepage:
• Size: 101 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Schemagic

![Ruby Version](https://img.shields.io/badge/Ruby->=%202.7.0-CC342D.svg)

[![License](https://img.shields.io/github/license/tcd/eddy)](https://github.com/tcd/schemagic/blob/master/LICENSE)

Generate JSON schemas for Rails models using [YARD](https://github.com/lsegal/yard) doc comments.

***WIP:** Generate Rails models from JSON schemas.*

## Installation

### 1. Add this line to your application's Gemfile:

```ruby

gem "schemagic", github: "tcd/schemagic" # issues with Google Authenticator & RubyGems; have not published yet

```

### 2. Install by running:

```bash

bundle install

```

### 3. Generate an initializers for configuration:

```bash

rails schemagic:install

```

### 4. Generate some JSON schemas:

```bash

rails schemagic:from_yard

```

## License

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