CodingItWrong/riverbed-api

Backend API for Riverbed, an app for creating CRUD apps with interactivity with no programming.

Riverbed API

Backend API for Riverbed, an app for creating interactive CRUD apps with no programming.

Getting Started

Requirements

1. Ruby
2. PostgreSQL (e.g. Postgres.app)

Setup

$ bundle install
$ rails db:setup

Development

To generate models, resources, and controllers:

$ rails generate model widget [fields]
$ rails generate jsonapi:resource widget
$ rails generate jsonapi:controller widget

Testing

$ bin/rspec

In request tests, you can use the user and access token factories to create test data to access protected resources:

user = FactoryBot.create(:user)
token = FactoryBot.create(:access_token, resource_owner_id: user.id).token
headers = {
  'Authorization' => "Bearer #{token}",
  'Content-Type' => 'application/vnd.api+json',
}

# assuming you have a Widget model that belongs to a User
FactoryBot.create(:widget, user: user)

get '/widgets', headers: headers

Running

$ bin/serve

This opens ports so can be accessed from physical devices.

Copyright and License

Copyright 2023 NeedBee, LLC.

Licensed under GNU Affero General Public License (GNU AGPL) version 3 or later. See LICENSE.md for details.