You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: getting_started/javascript-client/lesson_1.md
+17-17Lines changed: 17 additions & 17 deletions
Original file line number
Diff line number
Diff line change
@@ -1,40 +1,40 @@
1
-
# Lesson 1 - Installing, start project and create an empty database with schema
1
+
# Lesson 1 - Install, start a project, and create an empty database with a schema
2
2
3
3
## Installing
4
4
5
-
You can download the TerminusDB docker image to work locally (recommended to use [Bootstrap here](https://github.com/terminusdb/terminusdb-bootstrap)) or you can connect to TerminusCMS. If you are using docker image, make sure that your TerminusDB container is running at localhost (https://127.0.0.1). If you are using TerminusCMS, get the information of the endpoint, team, and API token ready (it should be accessible in the [TerminusCMS dashboard](https://dashboard.terminusdb.com/) under profile.)
5
+
You can download the TerminusDB Docker image to work locally - we recommend to using the [Bootstrap Install](https://github.com/terminusdb/terminusdb-bootstrap)) or connectting with our hosted service, TerminusCMS. If you are using the Docker image, make sure that your TerminusDB container is running at localhost (https://127.0.0.1). If you are using TerminusCMS, get the information of the endpoint, team, and API token ready - you can find these in the [TerminusCMS dashboard](https://dashboard.terminusdb.com/), under profile.)
6
6
7
7
It is recommended to install the TerminusDB Javascript client (works with [Nodejs >= 10](https://nodejs.org/en/download/)) in a separate new nodejs project.
8
8
9
-
## Start Project
9
+
## Start a Project
10
10
11
-
Now go to the project directory (or start a new one):
11
+
Go to the project directory (or start a new one):
12
12
13
13
```
14
14
cd ../getting_started
15
15
```
16
16
17
-
Then we will create a new NodeJS project using npm:
17
+
Create a new NodeJS project using npm:
18
18
19
19
```
20
20
npm init -y
21
21
```
22
22
23
-
Then we can install client package using npm:
23
+
Install the TerminusDB JS client package using npm:
24
24
25
25
```
26
26
npm i @terminusdb/terminusdb-client
27
27
```
28
28
29
29
30
-
In the project directory create a new file called as schema.js
30
+
In the project directory, create a new file called as schema.js
31
31
32
32
33
-
## Create an Empty Database with Schema
33
+
## Create an Empty Database with a Schema
34
34
35
-
Now create a new file called as `schema.js` with `schema.js` you can build a schema for our new database.
35
+
Create a new file called `schema.js`. With the `schema.js` you can build a schema for the new database.
36
36
37
-
In this tutorial series, we will use a fabricated phone book database of a company as an example. It consists of only 2 tables, the first one is the structure of the company ([Employees.csv](Employees.csv)):
37
+
We'll use a company's phonebook database as an example. It consists of 2 tables, the first is the personnel of the company ([Employees.csv](Employees.csv)):
To verify the schema is committed, if you are using TerminusCMS, you can see changes in the dashboard. Since we are using TerminusDB locally (it works with TerminusCMS as well), we can look at the commit history by:
125
+
To verify the schema is committed we can look at the commit history using the example below. If you are using TerminusCMS, you can see changes in the dashboard.
126
126
127
127
```javascript
128
128
// Get commit history
@@ -133,14 +133,14 @@ To verify the schema is committed, if you are using TerminusCMS, you can see cha
133
133
console.log(res.bindings);
134
134
```
135
135
136
-
Also, you can look at the objects in the schema graph like this:
136
+
You can also look at the objects in the schema graph like this:
0 commit comments