Merge pull request #15 from imagekit-developer/naming-convention

Naming convention

Author: imagekitio

.gitignore

@@ -1,3 +1,4 @@
+.DS_Store
 node_modules
 .vscode/settings.json
 .vscode/launch.json

DEVELOPMENT.md

@@ -1,18 +1,18 @@
 ## Building package
 
-Execute following command from the root folder to build the library. This creates a package in `dist` folder.
+Execute the following command from the root folder to build the library. This creates a package in the `dist` folder.
 ```sh
-npm install # for first time
-npm run build
+yarn install # for first-time
+yarn build
 ```
 
 ## Running test cases
 
-The designated directory for tests is `/tests` folder. All tests will be run against the assertion present in the `/tests/__snapshot__` folder. To create this file you need to just run below command just once. Any update in the tests can be updated to by pressing `u` while the test environment is running.
+The designated directory for tests is `/tests` folder. All tests will be run against the assertion present in the `/tests/__snapshot__` folder. To create this file, you need to just run the below command just once. Any update in the tests can be updated to by pressing `u` while the test environment is running.
 
-Execute following command from the root folder to start testing.
+Execute the following command from the root folder to start testing.
 ```sh
-npm run test:dev
+yarn test:dev
 ```
 
 ## Running sample frontend Vue app

README.md

@@ -1,6 +1,6 @@
 module.exports = {
   presets: [
-    '@vue/cli-plugin-babel/preset'
+    "@babel/env"
   ],
   env: {
     "test": {

babel.config.js

@@ -1,6 +1,6 @@
 {
   "name": "imagekitio-vue",
-  "version": "1.0.5",
+  "version": "1.0.6",
   "scripts": {
     "build:lib": "./node_modules/.bin/vue-cli-service build --target lib src/index.js",
     "build": "./node_modules/.bin/vue-cli-service lint --fix; npm run build:lib",
@@ -21,11 +21,7 @@
     "url": "https://github.com/imagekit-developer/imagekit-vuejs"
   },
   "dependencies": {
-    "babel-plugin-require-context-hook": "^1.0.0",
-    "core-js": "^3.4.3",
-    "imagekit-javascript": "^1.2.0",
-    "jest-vue-preprocessor": "^1.7.0",
-    "vue": "^2.6.11"
+    "imagekit-javascript": "^1.3.3"
   },
   "devDependencies": {
     "@babel/core": "^7.7.7",
@@ -65,8 +61,12 @@
       "parser": "babel-eslint"
     }
   },
+  "license": "MIT",
   "browserslist": [
     "> 1%",
     "last 2 versions"
-  ]
+  ],
+  "peerDependencies": {
+    "vue": "^2.6.12"
+  }
 }

package-lock.json

@@ -1,60 +1,21 @@
-## Installation
-
-Run the following commands from your shell.
-
-### Getting the SDK ready
-
-We will first go to the root,
-
-```bash
-cd ../../
-```
-
-Install the node modules,
-```bash
-npm install
-```
-
-Create the dist:
-
-```bash
-npm run build
-```
-
-### Installing the sample-app
-
-Now, Go to `sample-app` by,
-```bash
-cd samples/sample-app
-```
-
-then,
-```bash
-npm install
-```
-
-## Setting the environment variable
-Create a .env file by renaming the sample.env in examples/sample-app
+## Starting the frontend app
+Create a .env file by renaming the sample.env in examples/sample-app. Fill in the required parameters according to your imagekit account.
 
-Fill is the required parameters according to your imagekit account.
+Inside samples/sample-app, run
 
-## Starting the frontend app
-Finally run the app,
 ```bash
-npm run serve
+yarn install
+yarn serve
 ```
 
 Open http://localhost:8080/ in the browser.
 
-To run the upload component you also will have set up a server
-
-## Setting up the server
-There is a sample server present in the sample app directory in server directory. 
-It takes the `private key` from .env file, so create a .env file by renaming the sample.env in `samples/sample-app/server`
+To use the upload component, you also will have to implement authenticationEndpoint as required during SDK initialization. This sample app has an example backend implementation.
 
-To run this server, go to server directory `cd server`, then run
+## Setting up the backend server
+Create a .env file by renaming the sample.env in `samples/sample-app/server` and set the `PRIVATE_KEY`. Then run
 
 ```bash
-npm install
-npm run server
-```
+yarn install
+node server.js
+```