WIP: Node.js Client SDK Tutorial #141
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
|
| ## Introduction | ||
| In this tutorial, we’ll explore how to create a new Node.js applicaiton with TypeScript and PowerSync for offline-first capabilities. In the following sections, we’ll walk through the process of integrating PowerSync into a Node.js application, setting up local-first storage, and handling synchronization efficiently. | ||
|
|
||
| ## Prerequisits |
There was a problem hiding this comment.
This could be a Warning note to make it stand out
|
|
||
| ## Setup | ||
|
|
||
| ### Creating a new project |
There was a problem hiding this comment.
nit: This section could be merged into Project Setup
| ... | ||
| ``` | ||
|
|
||
| <Note>The PowerSync Node.js SDK requires `@powersync/better-sqlite3` to be installed</Note> |
There was a problem hiding this comment.
A link to thee PowerSync Node.js SDK would be helpful. Not sure if this is the right place for it though.
|
|
||
| ### Adding PowerSync | ||
|
|
||
| Create a `src` directory and add three files: |
There was a problem hiding this comment.
Suggested change
| Create a `src` directory and add three files: | |
| Create a `src` directory and add the following three files: |
| ``` | ||
|
|
||
| #### Connector.ts | ||
| This file will be the connector which will fetch a JWT used by PowerSync for authentication and another function which will handle uploads to the backend source database. |
There was a problem hiding this comment.
Suggested change
| This file will be the connector which will fetch a JWT used by PowerSync for authentication and another function which will handle uploads to the backend source database. | |
| This file will serve as the connector, responsible for retrieving a JWT for PowerSync authentication and providing a function to handle uploads to the backend source database. |
| ``` | ||
|
|
||
| #### index.ts | ||
| The main application file used in this guide to show you how to set up and initialize PowerSync. |
There was a problem hiding this comment.
Suggested change
| The main application file used in this guide to show you how to set up and initialize PowerSync. | |
| The main application file used in this guide which demonstrates how to set up and initialize PowerSync. |
| This will start the app, initialize the database and connect to the PowerSync instance. | ||
|
|
||
| <Warning> | ||
| Depending on what you set for `dbFilename`, the app start (and all is working correctly) three files will be created; `<dbFilename>.db`, `<dbFilename>.db-shm` and `<dbFilename>.db-wal`. You should exclude these from version control when creating the project so make sure to update your `.gitignore` accordingly. |
There was a problem hiding this comment.
This is a little confusing
the app start (and all is working correctly) three files will be created;
| ## Introduction | ||
| In this tutorial, we’ll explore how to create a new Node.js applicaiton with TypeScript and PowerSync for offline-first capabilities. In the following sections, we’ll walk through the process of integrating PowerSync into a Node.js application, setting up local-first storage, and handling synchronization efficiently. | ||
|
|
||
| ## Prerequisits |
There was a problem hiding this comment.
Suggested change
| ## Prerequisits | |
| ## Prerequisites |
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR introduces a "from scratch" node.js tutorial for developers. This is WIP and needs more polish.