Skip to content
This repository has been archived by the owner on Oct 3, 2019. It is now read-only.
/ jls_api_rails Public archive

Easy to use JLS:API server framework for Ruby on Rails backends.

License

Notifications You must be signed in to change notification settings

FlineDev/jls_api_rails

Repository files navigation

Build Status

JLS:API Rails

Easy to use JLS:API server framework for Ruby on Rails backends.

Installation

Add this line to your application's Gemfile:

gem 'jls_api_rails'

And then execute:

$ bundle

Or install it yourself as:

$ gem install jls_api_rails

To complete the installation execute:

$ rails g jls_api:install

Usage

Endpoint Generator

To create a new endpoint, say /users, just run this:

$ rails g jls_api:endpoint users

This will generate files which you can edit to define your new API endpoint.

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.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/Flinesoft/jls_api_rails. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

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

Code of Conduct

Everyone interacting in the JLS:API Rails project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.

About

Easy to use JLS:API server framework for Ruby on Rails backends.

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages