/# Adonis Ramenbox

Installation

Adonis Ramenbox requires Adonisjs v4 to run.

Install the PeerDependencies in your host application

1    "@adonisjs/bodyparser": "^2.0.5",
2    "@adonisjs/cors": "^1.0.7",
3    "@adonisjs/drive": "^1.0.4",
4    "@adonisjs/fold": "^4.0.9",
5    "@adonisjs/generic-exceptions": "^3.0.1",
6    "@adonisjs/validator": "^5.0.6",
7    "adonis-bumblebee": "^2.1.0",
8    "adonis-lucid-filter": "^1.0.5",
9    "@ordentco/adonis-drive": "^1.0.2",
10    "@slynova/flydrive": "^1.0.3",
11    "@slynova/flydrive-gcs": "^1.0.3"

set your config/drive.js

1'use strict'
2
3const Helpers = use('Helpers')
4const Env = use('Env')
5
6module.exports = {
7  /*
8  |--------------------------------------------------------------------------
9  | Default disk
10  |--------------------------------------------------------------------------
11  |
12  | The default disk is used when you interact with the file system without
13  | defining a disk name
14  |
15  */
16  default: 'local',
17
18  disks: {
19    /*
20    |--------------------------------------------------------------------------
21    | Local
22    |--------------------------------------------------------------------------
23    |
24    | Local disk interacts with the a local folder inside your application
25    |
26    */
27    local: {
28      driver: 'local',
29      config: {
30        root: Helpers.tmpPath()
31      }
32    },
33
34    /*
35    |--------------------------------------------------------------------------
36    | S3
37    |--------------------------------------------------------------------------
38    |
39    | S3 disk interacts with a bucket on aws s3
40    |
41    */
42    s3: {
43      driver: 's3',
44      config: {
45        key: Env.get('S3_KEY'),
46        secret: Env.get('S3_SECRET'),
47        bucket: Env.get('S3_BUCKET'),
48        region: Env.get('S3_REGION')
49      }
50    },
51
52    gcs: {
53      driver: 'gcs',
54      config: {
55        keyFilename: Env.get('GCS_KEY_FILE_NAME'), // path to json file
56        bucket: Env.get('GCS_BUCKET')
57      }
58    }
59  }
60}

add provider to start/app.js

1const providers = [
2  ...
3  '@adonisjs/validator/providers/ValidatorProvider',
4  '@ordentco/adonis-drive/providers/DriveProvider',
5  'adonis-bumblebee/providers/BumblebeeProvider',
6  'adonis-lucid-filter/providers/LucidFilterProvider',
7  ...
8]

Controller

1const RamenController = require('../../../packages/ramenbox/src/Controller/RamenController')

Model

1const RamenController = require('../../../packages/ramenbox/src/Controller/RamenController')

Properties

1static get properties () {
2		return ['id', 'username', 'password', 'email', 'created_at', 'updated_at', 'image']
3    }

Slug

1static get slug(){
2        return 'email'
3    }

Rules

1    static get rules(){
2        return {
3            post: {
4                email: 'required|email|unique:users,email',
5                username: 'required'
6            }
7        }
8    }

Relations

1    static get relations(){
2        return ['profiles', 'tokens']
3    }

Sanitize

1    static get sanitize(){
2        return {
3            post: {
4                'email': 'normalize_email'
5            }
6        }
7    }

Transformer

1    const RamenTransformer = require('../../../packages/ramenbox/src/Controller/RamenController')