Added getting started tutorial for javascript client

Signed-off-by: NeelParihar <[email protected]>

Author: NeelParihar

Diff for: getting_started/Contact.csv renamed to getting_started/javascript-client/Contact.csv

@@ -0,0 +1,30 @@
+# Getting started using TerminusDB Javascript Client
+
+This is a step by step tutorial to get you started using TerminusDB/ TerminusX for the first time. This will cover all the basics that you can work with TerminusDB/ TerminusX using the Javascript client.
+
+- [Lesson 1 - Installing, start project and create an empty database with schema](lesson_1.md)
+- [Lesson 2 - Importing data form CSV using Javascript script](lesson_2.md)
+- [Lesson 3 - Update and import new data that links to old data](lesson_3.md)
+- [Lesson 4 - Query on the database and get result back as json](lesson_4.md)
+- [Lesson 5 - Version control: time travel, branching and rebase](lesson_5.md)
+
+## Extra lessons:
+
+### Working with Singer.io
+
+Here are a few example/ tutorials showing how to work with Singer.io, an open-source ELT tool to build data pipelines with taps and targets.
+
+[Exporting Data to Google Sheets with Singer.io](https://github.com/terminusdb/terminusdb-tutorials/tree/master/google_sheets/README.md)
+
+Example of showing how to export data from TerminusDB/ TerminusX to Google Sheets with Singer.io target.
+
+[Putting GitHub Data into TerminusDB/ TerminusX](https://github.com/terminusdb/terminusdb-tutorials/tree/master/github_data/README.md)
+
+Example of showing how to import data from GitHub and store it in TerminusDB/ TerminusX with Singer.io tap.
+
+[The COVID-19 Public Data with Singer.io](https://github.com/terminusdb/terminusdb-tutorials/tree/master/covid_data/README.md)
+
+Example of showing how to import data (COVID-19 Public Data) from a Singer.io tap to TerminusDB/ TerminusX.
+
+### Working with JupyterLab/ Jupyter notebook
+(Coming soon)

Diff for: getting_started/Employees.csv renamed to getting_started/javascript-client/Employees.csv

@@ -0,0 +1,99 @@
+const TerminusClient = require("@terminusdb/terminusdb-client");
+
+// Connecting to TerminusX
+// TODO: Change teamname
+const client = new TerminusClient.WOQLClient(
+  "https://cloud.terminusdb.com/cloudux/",
+  { user: "username", organization: "cloudux", db: "GettingStartedDB" }
+);
+
+//Assign your key to environment variable TERMINUSDB_ACCESS_TOKEN
+client.setApiKey(process.env.TERMINUSDB_ACCESS_TOKEN);
+
+const getCommitHistory = async (branch) => {
+
+  const woqlLib = TerminusClient.WOQL;
+  const commitQuery = woqlLib.lib().commits(branch);
+
+  const res = await client.query(commitQuery);
+  console.log(res.bindings);
+};
+
+const addContractors = async () => {
+
+  const rhys = {
+    "@type": "Employee",
+    employee_id: "006",
+    name: "Rhys Arnold",
+    title: "UX Designer",
+    team: "IT",
+    contact_number: "078 3951 7569",
+    address: {
+      "@type": "Address",
+      postcode: "DG4 2ZQ",
+      street: "Helland Bridge",
+      street_num: 1,
+      town: "Ulzieside",
+    },
+  };
+
+  const maya = {
+    "@type": "Employee",
+    employee_id: "007",
+    name: "Maya O'Brien",
+    title: "Creative Content Creator",
+    team: "Marketing",
+    contact_number: "078 1788 9177",
+    address: {
+      "@type": "Address",
+      postcode: "GU3 3AF",
+      street: "Tadcaster Rd",
+      street_num: 24,
+      town: "Pitch Place",
+    },
+  };
+  await client.addDocument([rhys, maya],{},"","Adding contractors");
+};
+
+
+const runScript = async () => {
+
+  const defaultBranches = await client.getBranches();
+  console.log("Default Branches: ", defaultBranches);
+
+  // Create new contractor branch
+  await client.branch("contractors");
+  console.log("Branch created successfully!")
+
+  const newBranches = await client.getBranches();
+  console.log("New Branches: ", newBranches);
+
+  // checkout to new branch contractors
+  client.checkout("contractors");
+
+  await addContractors();
+  console.log("Added Contractors successfully!")
+
+  
+  console.log("Main Commit History: ")
+  await getCommitHistory("main");
+
+
+  console.log("Contractors Commit History: ")
+  await getCommitHistory("contractors");
+
+  client.checkout("main");
+
+  await client.rebase({rebase_from: "cloudux/GettingStartedDB/local/branch/contractors/", message: "Merging from contractors" , author: "USer"});
+  console.log("Rebase done successfully!");
+
+  console.log("main Commit History: ")
+  await getCommitHistory("main");
+
+  await client.resetBranch("main", "2zt3shmtvrrdsk63kvdxiwtzakthwb3"); 
+  console.log("Reset done successfully!");
+
+  console.log("Main Commit History: ")
+  await getCommitHistory("main");
+}
+runScript();

Diff for: getting_started/javascript-client/README.md

@@ -0,0 +1,98 @@
+const fs = require("fs");
+const path = require("path");
+const csv = require("fast-csv");
+
+const TerminusClient = require("@terminusdb/terminusdb-client");
+
+
+// Connecting to TerminusX
+// TODO: Change teamname
+const client = new TerminusClient.WOQLClient(
+  "https://cloud.terminusdb.com/teamname/",
+  { user: "username", organization: "teamname", db: "GettingStartedDB"}
+);
+
+//Assign your key to environment variable TERMINUSDB_ACCESS_TOKEN
+client.setApiKey(process.env.TERMINUSDB_ACCESS_TOKEN);
+
+const contact_numbers = {};
+const addresses = {};
+const employees = [];
+
+// function to load and parse huge CSV files
+const readCsv = (fileName) => {
+    // TODO: change the directoryPath to point were the csv are stored
+    const directoryPath = "../../terminusdb-tutorials/getting_started/javascript/"
+    return new Promise((resolve, reject) => {
+      const data = [];
+  
+      fs.createReadStream(
+        path.resolve(
+          __dirname,
+          directoryPath,
+          fileName
+        )
+      )
+        .pipe(csv.parse({ headers: true, ignoreEmpty: true }))
+        .on("error", reject)
+        .on("data", (row) => data.push(row))
+        .on("end", () => {
+          console.log(`Parsed ${data.length} rows`);
+          resolve(data);
+        });
+    });
+  };
+
+const insertData = async () => {
+  // read Contact.csv
+  let resultContacts = await readCsv("Contact.csv");
+  resultContacts.forEach((element) => {
+    contact_numbers[element["Employee id"]] = element["Contact number"];
+
+    let street = element["Home address"].split(",")[0];
+    let street_num = Number(street.split(" ")[0]);
+    let street_name = street.split(" ").slice(1).join(" ");
+    let town = element["Home address"].split(",")[1].substr(1);
+
+    addresses[element["Employee id"]] = {
+      "@type": "Address",
+      street: street_name,
+      street_num,
+      town,
+      postcode: element["Postcode"],
+    };
+  });
+
+  let resultEmployees = await readCsv("Employees.csv");
+  resultEmployees.forEach((element) => {
+    let employee = {
+      "@type": "Employee",
+      name: element["Name"],
+      title: element["Title"],
+      team: element["Team"],
+      address: addresses[element["Employee id"]],
+      contact_number: contact_numbers[element["Employee id"]],
+      employee_id: element["Employee id"],
+    };
+
+    if (element["Manager"] !== "")
+      employee.manager = "Employee/" + element["Manager"];
+
+    employees.push(employee);
+  });
+  console.log("Inserting Employees ", employees);
+
+  client
+    .addDocument(employees)
+    .then((res) => {
+      console.log("Employees inserted successfully", res);
+    })
+    .catch((error) => {
+      console.log(error);
+    });
+
+    const result = await client.getDocument({"as_list":true});
+    console.log(result);
+};
+
+insertData();