Skip to content

Commit d71e57d

Browse files
authored
Updated language
Updated language and documentation links
1 parent 1624a2e commit d71e57d

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

getting_started/javascript-client/lesson_1.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff 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
22

33
## Installing
44

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.)
66

77
It is recommended to install the TerminusDB Javascript client (works with [Nodejs >= 10](https://nodejs.org/en/download/)) in a separate new nodejs project.
88

9-
## Start Project
9+
## Start a Project
1010

11-
Now go to the project directory (or start a new one):
11+
Go to the project directory (or start a new one):
1212

1313
```
1414
cd ../getting_started
1515
```
1616

17-
Then we will create a new NodeJS project using npm:
17+
Create a new NodeJS project using npm:
1818

1919
```
2020
npm init -y
2121
```
2222

23-
Then we can install client package using npm:
23+
Install the TerminusDB JS client package using npm:
2424

2525
```
2626
npm i @terminusdb/terminusdb-client
2727
```
2828

2929

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
3131

3232

33-
## Create an Empty Database with Schema
33+
## Create an Empty Database with a Schema
3434

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.
3636

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)):
3838

3939
| Employee id | Name | Title | Team | Manager |
4040
| ----------- | -------------- | ------------------- | ----------- | ----------- |
@@ -43,7 +43,7 @@ In this tutorial series, we will use a fabricated phone book database of a compa
4343
| 003 | Alanah Bloggs | Frontend Developer | IT | 004 |
4444
| 004 | Fabian Dalby | Web Service Manager | IT | |
4545

46-
And the other is the contact details of the employees ([Contact.csv](Contact.csv)):
46+
And the other is the contact details for employees ([Contact.csv](Contact.csv)):
4747

4848
| Employee id | Contact number | Home address | Postcode |
4949
| ----------- | --------------- | ----------------------------- | -------- |
@@ -52,9 +52,9 @@ And the other is the contact details of the employees ([Contact.csv](Contact.csv
5252
| 003 | (01274) 708080 | 139 Otley Road, Shipley | BD18 2PT |
5353
| 004 | (0161) 532 7302 | 2 Ansdell Road, Stockport | SK5 6SY |
5454

55-
If you want to learn more about how schemas work you can refer this [documentation](https://terminusdb.com/docs/v10.0/#/reference/reference-schema).
55+
Learn more about how schemas work by looking at the [Schema Reference Guide](https://terminusdb.com/docs/guides/reference-guides/schema).
5656

57-
The schema that I created for the above tables will be something like this:
57+
The schema we create for the above tables will look something like this:
5858

5959
```javascript
6060
const address_schema = {
@@ -122,7 +122,7 @@ const createDatabaseAndSchema = async () => {
122122
createDatabaseAndSchema();
123123
```
124124

125-
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.
126126

127127
```javascript
128128
// Get commit history
@@ -133,14 +133,14 @@ To verify the schema is committed, if you are using TerminusCMS, you can see cha
133133
console.log(res.bindings);
134134
```
135135

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:
137137

138138
```javascript
139139
const result = await client.getDocument({"graph_type":"schema","as_list":true});
140140
console.log(result);
141141
```
142142

143-
The schema.js file will look like this in the end:
143+
The schema.js file will end up looking like this:
144144

145145
```javascript
146146
const TerminusClient = require("@terminusdb/terminusdb-client");
@@ -232,4 +232,4 @@ createDatabaseAndSchema();
232232

233233
---
234234

235-
[Move on to Lesson 2 - Importing data from CSV using Javascript script](lesson_2.md)
235+
[Lesson 2 - Importing data from CSV using Javascript script](lesson_2.md)

0 commit comments

Comments
 (0)