Addede readme file and a example Excel file

RobziChan · RobziChan · commit 7b334f7fefd7 · 2023-04-13T16:41:24.000+02:00
-Moved all the files to the correct folder "/examples/node-js-import-cards-with-excel".
-Added a readme.md file instead of having the documentation inside the main JS file.
-Added "nodejs_cards.xlsx" file as the example file for others.
diff --git a/examples/node-js-import-cards-with-excel/Import_Cards_From_Xlsx.js b/examples/node-js-import-cards-with-excel/Import_Cards_From_Xlsx.js
@@ -1,17 +1,3 @@
-/*
-This script uses the node "xlsx" libraray to read a .xlsx file and then read the content to
-figure out the user attributes in the first row/header.
-This means that you do not have to arange the order of the attributes in the header to make it work.
-The script checks to see that you do not have too few attributes in the header nor too many.
-After that the script creates a json object for each Card and sends it to the API endpoint: projects/<Workspace/Project ID>/cards/create-new
-
-Headers that will be used: "Due date" "Description" "Assignee" "Title" "Label" "Points" "Estimated time" "Blocked reason" "Column" "Checklist" "Co-assignees" "Activity" "Board id".
-If you have more headers that are not on the list above, then they will not be used, however you will not get any errors for having them.
-
-Information about the headers see the API documentation: https://service.projectplace.com/apidocs/#base/projects/1/projects/%3Cint:project_id%3E/cards/create-new
-
-*/
-
 const xlsx = require('node-xlsx');
 const request = require('request');
 const prompt = require('prompt-sync')();
diff --git a/examples/node-js-import-cards-with-excel/nodejs_cards.xlsx b/examples/node-js-import-cards-with-excel/nodejs_cards.xlsx
diff --git a/examples/node-js-import-cards-with-excel/readme.md b/examples/node-js-import-cards-with-excel/readme.md
@@ -0,0 +1,28 @@
+# Upload Cards from Xlsx file
+This NodeJS script reads the provided Xlsx file and creates Cards to the correct Board/Activity.
+The script requires a Oauth2 token in order to make the API calls to create the Cards, it will assume that you have already created one.
+#### 1. Install requirements
+See the `requirements.txt` file for the needed third-party libraries.
+#### 2. Run the script
+```
+node Import_Cards_From_Xlsx.js 
+```
+#### 3. Provide the necessary information
+* The script will ask first for your access token (Oauth2 token).
+* Then it will ask for the Workspace ID of where Board that you have provided in the Xlsx is located.
+* Lastly the script will ask the exact path for the Xlsx file.
+
+##### Note file name location
+If the Xlsx file is in `c:/User` folder, then you should provide the path as: `c:/user/FILENAME.xlsx`.
+
+##### See the test Xlsx file named: ```nodejs_cards.xlsx```
+Headers that will be used: **Due date, Description, Assignee, Title, Label, Points, Estimated time, Blocked reason, Column, Checklist, Co-assignees, Activity, Board id.**
+If you have more headers that are not on the list above, then they will not be used, however you will not get any errors for having them.
+***The headers does not have to be arange in any order for the script to work.***
+
+
+1. The script will get all the headers from the Xlsx file.
+2. Create a JSON object for each of the Cards.
+3. Lastly it will send the JSON object to the API endpoint: ```/cards/create-new```
+4. If any of the Cards failed to import then you will see those Cards in the console once the script is done.
+
