https://github.com/kaysiz/ideas-api

https://github.com/kaysiz/ideas-api

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/kaysiz/ideas-api
• Owner: kaysiz
• Created: 2019-08-29T08:57:10.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2021-08-03T03:21:34.000Z (over 3 years ago)
• Last Synced: 2024-04-22T14:56:19.450Z (9 months ago)
• Language: Ruby
• Homepage:
• Size: 74.2 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 15
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Ideas

This is a short description of your app.

## Getting Started

### Requirements

1. Ruby

1. PostgreSQL (e.g. [Postgres.app][postgres-app])

### Setup

```sh

$ bundle install

$ rails db:setup

```

### Development

To generate models, resources, and controllers:

```bash

$ rails generate model widget [fields]

$ rails generate jsonapi:resource widget

$ rails generate jsonapi:controller widget

```

### Testing

```sh

$ bin/rspec

```

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

```ruby

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

```sh

$ rails server

```

[postgres-app]: http://postgresapp.com