https://github.com/nejdetkadir/rails-6-api-boilerplate

A starter template for Ruby on Rails API
https://github.com/nejdetkadir/rails-6-api-boilerplate

rails rails-template rails6 ruby ruby-on-rails ruby-on-rails-6 ruby3-0 starter-kit starter-project starter-template

Last synced: 5 days ago
JSON representation

A starter template for Ruby on Rails API

• Host: GitHub
• URL: https://github.com/nejdetkadir/rails-6-api-boilerplate
• Owner: nejdetkadir
• License: gpl-3.0
• Created: 2021-08-30T17:26:01.000Z (about 3 years ago)
• Default Branch: master
• Last Pushed: 2021-11-03T21:11:55.000Z (about 3 years ago)
• Last Synced: 2024-11-02T16:25:30.724Z (10 days ago)
• Topics: rails, rails-template, rails6, ruby, ruby-on-rails, ruby-on-rails-6, ruby3-0, starter-kit, starter-project, starter-template
• Language: Ruby
• Homepage:
• Size: 82 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/cc0b1c55e4e443869e9473327b0abed3)](https://www.codacy.com/gh/nejdetkadir/rails-api-boilerplate/dashboard?utm_source=github.com&utm_medium=referral&utm_content=nejdetkadir/rails-api-boilerplate&utm_campaign=Badge_Grade)

# Rails API Boilerplate

A starter template for [Ruby on Rails API](https://guides.rubyonrails.org/api_app.html)

# Features

- Installed Gems

  - [devise](https://github.com/heartcombo/devise) with [devise-jwt](https://github.com/waiting-for-dev/devise-jwt) authenticatable

  - [faker](https://github.com/faker-ruby/faker)

  - [searchkick](https://github.com/ankane/searchkick)

  - [ruby-progressbar](https://github.com/jfelchner/ruby-progressbar)

  - [carrierwave](https://github.com/carrierwaveuploader/carrierwave)

  - [minimagick](https://github.com/minimagick/minimagick)

  - [pundit](https://github.com/varvet/pundit)

  - [rails-settings-cached](https://github.com/huacnlee/rails-settings-cached)

  - [whenever](https://github.com/javan/whenever)

# Installation

## Prerequisites

- [Ruby](https://rvm.io/)

- [NodeJS (>=10.x)](https://nodejs.org/en/download/package-manager/#debian-and-ubuntu-based-linux-distributions)

- [PostgreSQL](https://www.postgresql.org/download/)

- [ImageMagick](https://imagemagick.org/) `sudo apt-get install imagemagick libmagickcore-dev libmagickwand-dev`

## Installation

- Install GEM dependencies:

  ```bash

  bundle install

  ```

- Create database, migrate tables and run the seed data:

  ```bash

  rails db:create

  rails db:migrate

  rails db:seed

  ```

- If you are setting up again, when you already have previous databases:

  ```bash

  rails db:reset

  ```

- For dropping database

  ```bash

  rails db:drop

  ``` 

# LICENSE

```

GNU GENERAL PUBLIC LICENSE Version 3

```