https://github.com/thirunjuguna/natra

Natra generate a light weight sinatra application.It's ideal for building containerized api services
https://github.com/thirunjuguna/natra

api-service microservices ruby-gem ruby-webapp sinatra-applications

Last synced: about 1 month ago
JSON representation

Natra generate a light weight sinatra application.It's ideal for building containerized api services

• Host: GitHub
• URL: https://github.com/thirunjuguna/natra
• Owner: thirunjuguna
• License: mit
• Created: 2018-10-27T19:28:07.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2023-01-18T02:06:40.000Z (almost 2 years ago)
• Last Synced: 2024-11-17T05:38:20.289Z (about 2 months ago)
• Topics: api-service, microservices, ruby-gem, ruby-webapp, sinatra-applications
• Language: Ruby
• Homepage: https://rubygems.org/gems/natra
• Size: 124 KB
• Stars: 3
• Watchers: 2
• Forks: 2
• Open Issues: 18
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# Natra

[![Coverage Status](https://coveralls.io/repos/github/thirunjuguna/natra/badge.svg?branch=master)](https://coveralls.io/github/thirunjuguna/natra?branch=master)

[![Build Status](https://travis-ci.com/thirunjuguna/natra.svg?branch=master)](https://travis-ci.com/thirunjuguna/natra) 

[![Maintainability](https://api.codeclimate.com/v1/badges/e76bbd27a1c4cb8911ae/maintainability)](https://codeclimate.com/github/thirunjuguna/natra/maintainability)

[![Codacy Badge](https://api.codacy.com/project/badge/Grade/450f5da9d33d4adca897563ec759c1b2)](https://www.codacy.com/app/thirunjuguna/natra?utm_source=github.com&utm_medium=referral&utm_content=thirunjuguna/natra&utm_campaign=Badge_Grade)

## Installation

Add this line to your application's Gemfile:

```ruby

gem 'natra'

```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install natra

## Commands

```

natra -v              # Show Natra version number

natra help [COMMAND]  # Describe available commands or one specific command

natra new APP-NAME    # Creates a new Sinatra application

natra model NAME      # Generate a model

natra controller NAME # Generate a controller

natra scaffold NAME   # Generate a model with its associated views and controllers

```

The controller generator also have an optional views flag `--no-views` to create controllers without views.

## Using Natra

To generate your app:

    natra new APP-NAME

After natra is done generating your app, run `bundle install` from your app's directory:

    cd APP-NAME

    bundle install

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/thirunjuguna/natra. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

## License

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

## Code of Conduct

Everyone interacting in the Natra project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/thirunjuguna/natra/blob/master/CODE_OF_CONDUCT.md).