Giter Club home page Giter Club logo

boring-bits-rails-api's Introduction

๐Ÿ˜ด Boring Bits: Rails API Edition

A bare-bones Rails 6 template for API-only applications which use JWT authentication.

It's not glamourous. It's not sexy. It's just a dependably Boring starting point for your next API.

Plays nicely with Boring Bits: Nextjs Edition.

Highlights

  • Devise auth with JSON Web Tokens (JWT)
  • Login, signup, and protected route examples
  • JSON:API response rendering
  • Namespaced /api/ routes
  • TDD-ready with passing Rspec tests

Getting started

Ensure you have Ruby 2.6.x and Rails 6 installed on your machine.

Clone this repository, then specify your local path to template.rb with the -m flag:

$ rails new YourAppName --api -m ../local/path/to/template.rb

The template will install all necessary gems, and create a new database for you. Check everything is installed correctly by cd-ing into YourAppName, then running the specs with:

$ foreman run rake

Making API calls

API calls are authenticated with JWT tokens taken from the Authorization header. See spec/controllers/user_controller_spec.rb for an example.

Authorization headers are returned by login and signup routes, so you need to save the header value client-side, then include that header with your subsequent API requests.

boring-bits-rails-api's People

Contributors

jameschambers avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.