Merge pull request #2 from Dahkenangnon/dev

Dahkenangnon · web-flow · commit 13a492078777 · 2021-01-02T10:58:09.000+01:00
Add docs
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,7 @@
+## 1.0.8-dev
+## 1.0.7-dev
+## 1.0.6-dev
+## 1.0.5-dev
 ## 1.0.4-dev
 ## 1.0.3-dev
 ## 1.0.2-dev
diff --git a/README.md b/README.md
@@ -71,4 +71,5 @@ var reAuthResponse = await flutterFeathersjs.reAuthenticate()
 ## Contribution
 
 - Contact-me for improvment or contribution purpose
-- Example is coming
+- Example is coming
+- Looking for contributor
diff --git a/docs/.gitignore b/docs/.gitignore
@@ -0,0 +1,12 @@
+pids
+logs
+node_modules
+npm-debug.log
+coverage/
+run
+dist
+.DS_Store
+.nyc_output
+.basement
+config.local.js
+basement_dist
diff --git a/docs/package.json b/docs/package.json
@@ -0,0 +1,20 @@
+{
+  "name": "flutter_feathersjs",
+  "version": "0.0.1",
+  "description": "Communicate with your feathers js server from flutter",
+  "main": "index.js",
+  "authors": {
+    "name": "Justin Y. Dah-kenangnon",
+    "email": "dah.kenangnon@gmail.com"
+  },
+  "repository": "https://github.com/Dahkenangnon/flutter_feathersjs.dart/flutter_feathersjs",
+  "scripts": {
+    "dev": "vuepress dev src",
+    "build": "vuepress build src"
+  },
+  "license": "MIT",
+  "devDependencies": {
+    "@vuepress/plugin-nprogress": "^1.7.1",
+    "vuepress": "^1.5.3"
+  }
+}
diff --git a/docs/src/.vuepress/components/Foo/Bar.vue b/docs/src/.vuepress/components/Foo/Bar.vue
@@ -0,0 +1,15 @@
+<template>
+  <p class="demo">
+    {{ msg }}
+  </p>
+</template>
+
+<script>
+  export default {
+    data () {
+      return {
+        msg: 'Hello this is <Foo-Bar>'
+      }
+    }
+  }
+</script>
diff --git a/docs/src/.vuepress/components/OtherComponent.vue b/docs/src/.vuepress/components/OtherComponent.vue
@@ -0,0 +1,3 @@
+<template>
+  <p class="demo">This is another component</p>
+</template>
diff --git a/docs/src/.vuepress/components/demo-component.vue b/docs/src/.vuepress/components/demo-component.vue
@@ -0,0 +1,15 @@
+<template>
+  <p class="demo">
+    {{ msg }}
+  </p>
+</template>
+
+<script>
+  export default {
+    data() {
+      return {
+        msg: 'Hello this is <demo-component>'
+      }
+    }
+  }
+</script>
diff --git a/docs/src/.vuepress/config.js b/docs/src/.vuepress/config.js
@@ -0,0 +1,74 @@
+const { description } = require('../../package')
+
+module.exports = {
+    /**
+     * Ref：https://v1.vuepress.vuejs.org/config/#title
+     */
+    title: 'FlutterFeatherjs',
+    /**
+     * Ref：https://v1.vuepress.vuejs.org/config/#description
+     */
+    description: description,
+
+    /**
+     * Extra tags to be injected to the page HTML `<head>`
+     *
+     * ref：https://v1.vuepress.vuejs.org/config/#head
+     */
+    head: [
+        ['meta', { name: 'theme-color', content: '#3eaf7c' }],
+        ['meta', { name: 'apple-mobile-web-app-capable', content: 'yes' }],
+        ['meta', { name: 'apple-mobile-web-app-status-bar-style', content: 'black' }],
+        ['link', { rel: 'icon', href: '/assets/img/logo.png' }]
+    ],
+
+    /**
+     * Theme configuration, here is the default theme configuration for VuePress.
+     *
+     * ref：https://v1.vuepress.vuejs.org/theme/default-theme-config.html
+     */
+    themeConfig: {
+        repo: '',
+        editLinks: false,
+        docsDir: '',
+        editLinkText: '',
+        lastUpdated: true,
+        nav: [{
+                text: 'Guide',
+                link: '/guide/',
+            },
+            {
+                text: 'Github',
+                link: 'https://github.com/Dahkenangnon/flutter_feathersjs.dart'
+            },
+            {
+                text: 'Pub.Dev',
+                link: 'https://pub.dev/packages/flutter_feathersjs'
+            }
+        ],
+        sidebar: {
+            '/guide/': [{
+                title: 'Guide',
+                collapsable: true,
+                children: [
+                    '',
+                    'installation',
+                    'authentication',
+                    'using-rest',
+                    'using-socketio',
+                    'how-to-upload-file',
+                    'listening-event',
+                    'examples'
+                ]
+            }, ],
+        }
+    },
+
+    /**
+     * Apply plugins，ref：https://v1.vuepress.vuejs.org/zh/plugin/
+     */
+    plugins: [
+        '@vuepress/plugin-back-to-top',
+        '@vuepress/plugin-medium-zoom',
+    ]
+}
diff --git a/docs/src/.vuepress/enhanceApp.js b/docs/src/.vuepress/enhanceApp.js
@@ -0,0 +1,14 @@
+/**
+ * Client app enhancement file.
+ *
+ * https://v1.vuepress.vuejs.org/guide/basic-config.html#app-level-enhancements
+ */
+
+export default ({
+  Vue, // the version of Vue being used in the VuePress app
+  options, // the options for the root Vue instance
+  router, // the router instance for the app
+  siteData // site metadata
+}) => {
+  // ...apply enhancements for the site.
+}
diff --git a/docs/src/.vuepress/public/assets/img/logo.png b/docs/src/.vuepress/public/assets/img/logo.png
diff --git a/docs/src/.vuepress/styles/index.styl b/docs/src/.vuepress/styles/index.styl
@@ -0,0 +1,8 @@
+/**
+ * Custom Styles here.
+ *
+ * ref：https://v1.vuepress.vuejs.org/config/#index-styl
+ */
+
+.home .hero img
+  max-width 450px!important
diff --git a/docs/src/.vuepress/styles/palette.styl b/docs/src/.vuepress/styles/palette.styl
@@ -0,0 +1,11 @@
+/**
+ * Custom palette here.
+ *
+ * ref：https://v1.vuepress.vuejs.org/zh/config/#palette-styl
+ */
+
+$accentColor = #3eaf7c
+$textColor = #2c3e50
+$borderColor = #eaecef
+$codeBgColor = #282c34
+$nprogressColor = red
diff --git a/docs/src/guide/README.md b/docs/src/guide/README.md
@@ -0,0 +1,15 @@
+# Introduction
+
+## :bird: flutter_feathersjs :bird:
+
+Communicate with your feathers js [https://feathersjs.com/](https://feathersjs.com/) server from flutter.
+
+`Infos: Feathers js is a node framework for real-time applications and REST APIs.`
+
+
+*__FormData support out the box, auth, reAuth, socketio send event, rest ...__ 
+
+
+NB: I'm working on this doc and an example app which will be available very soon.
+
+:warning: This Doc is still dev, so it can contain some misspelled.
diff --git a/docs/src/guide/authentication.md b/docs/src/guide/authentication.md
@@ -0,0 +1,91 @@
+# Authentication
+
+Because we have two parts (scoketio and rest) which must communicate 
+with the same server (which required maybe authentication) we must found a way to authenticate 
+both rest & socketio once user is logged.
+
+Below, how to authenticate rest only or socketio only. But notice that in a production app, 
+you don't need to auth speratly the different client, just use the global authentication method.
+Nice ? Go
+
+## Auth rest
+
+You can for testing purpose only authenticate the rest client by doing the following.
+Note that when you use an other stratagy different from email/pass strategy, you must configure it on your server.
+
+```dart
+   // Auth with rest client with email/password [Default strategy]
+   var authResponse = await flutterFeathersjs.rest
+      .authenticate(userName: "mail@mail.com", password: "Strong_Pass");
+
+    // Or
+
+    // Auth with rest client with phone/password strategy
+   var authResponse = await flutterFeathersjs.rest.authenticate(
+      strategy: "phone",
+      userNameFieldName: "tel",
+      userName:"+22900000000",,
+      password: "Strong_Pass");
+
+```
+
+## Auth socketio
+
+The process to authenticate the socketio client is done after rest auth is os because,
+it using the JWT retrieved by rest client when process finished with ok. 
+
+```dart
+  // Note: This must be call after rest auth success
+  // Not recommanded to use this directly
+  var authResponse = await flutterFeathersjs.scketio.authWithJWT();
+
+```
+
+
+
+## Global Auth (recommanded)
+
+Definitely, this is what you must do when you want to authenticate your user.
+
+```dart
+
+/// ------ First time
+
+// Auth globaly with phone number strategy
+// When using this strategy: ensure you configure your feathers js server accordingly
+ var rep = await flutterFeathersjs.authenticate(
+      strategy: "phone",
+      userNameFieldName: "tel",
+      userName: "+22900000000",
+      password: "Strong_Pass");
+
+
+
+
+// Auth globaly with email  strategy [default]
+ var rep = await flutterFeathersjs.authenticate(
+      userName: "mail@mail.com",
+      password: "Strong_Pass");
+
+/// ------ On app restart or when JWT still validated
+ var reps = await flutterFeathersjs.reAuthenticate();
+
+    if (!reps["error"]) {
+      print('client is authed');
+      print("----------Authed user :------");
+      print(reps["message"]); // User is under  reps["message"] when all thing is Ok
+      print("----------Authed user :------");
+    } else
+    {
+      print(reps["message"]); // Error message is under  reps["message"] when something is wrong
+
+      // If you want to check when error is comming from socketio client
+      // Error message from socketio client,
+      print(reps["scketResponse"]);
+
+
+       // If you want to check when error is comming from rest client
+      // Error message from rest client,
+      print(reps["restResponse"]);
+    }
+```
diff --git a/docs/src/guide/examples.md b/docs/src/guide/examples.md
@@ -0,0 +1,3 @@
+# Examples
+
+Coming soon.
diff --git a/docs/src/guide/how-to-upload-file.md b/docs/src/guide/how-to-upload-file.md
@@ -0,0 +1,3 @@
+# Uploading file with FlutterFeathersJs
+
+Coming soon.
diff --git a/docs/src/guide/installation.md b/docs/src/guide/installation.md
@@ -0,0 +1,31 @@
+# Installation
+
+
+## Update your pubspec.yaml
+
+```yaml
+flutter_feathersjs: ^lastest
+```
+
+## Import it in your flutter code
+
+```dart
+
+import 'package:flutter_feathersjs/flutter_feathersjs.dart';
+
+```
+
+## Initialize it
+
+```dart
+
+
+//your  api
+const BASE_URL = "https://api.my-featherjs-domain.com";
+
+FlutterFeathersjs flutterFeathersjs = FlutterFeathersjs()
+    ..init(baseUrl: BASE_URL);
+
+```
+
+You're ready to go
diff --git a/docs/src/guide/listening-event.md b/docs/src/guide/listening-event.md
@@ -0,0 +1,3 @@
+# Realtime with FlutterFeatherJs
+
+Coming soon.
diff --git a/docs/src/guide/using-rest.md b/docs/src/guide/using-rest.md
@@ -0,0 +1,3 @@
+# Rest methods
+
+This is coming soon.
diff --git a/docs/src/guide/using-socketio.md b/docs/src/guide/using-socketio.md
@@ -0,0 +1,3 @@
+# Socketio methods
+
+This is coming soon.
diff --git a/docs/src/index.md b/docs/src/index.md
@@ -0,0 +1,15 @@
+---
+home: true
+heroImage: /assets/img/logo.png
+tagline: Communicate with your feathers js server from flutter
+actionText: Quick Start →
+actionLink: /guide/
+features:
+- title: Authentication
+  details: Support many auth strategies, auth both rest & socketio with single line.
+- title: Realtime event
+  details: The desired feature is of course the realtime. Don't worry, it's ok.
+- title: Rest & Socketio methods
+  details: Use as you want either rest or scoketio only methods as needed.
+footer: ❤️ MIT Licensed | Copyright © 2019-present Justin Y. Dah-kenangnon
+---
diff --git a/docs/vue.config.js b/docs/vue.config.js
@@ -0,0 +1,8 @@
+module.exports = {
+    themeConfig: {
+        logo: '/assets/img/logo.png',
+    },
+    plugins: ['@vuepress/nprogress', ['@vuepress/search', {
+        searchMaxSuggestions: 10
+    }]]
+}
diff --git a/docs/yarn.lock b/docs/yarn.lock
diff --git a/example/README.md b/example/README.md
diff --git a/lib/src/rest_client.dart b/lib/src/rest_client.dart
diff --git a/pubspec.yaml b/pubspec.yaml

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+<template>`
	`2`	`+ <p class="demo">This is another component</p>`
	`3`	`+</template>`