Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 19 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,22 @@
[![Contentstack](https://www.contentstack.com/docs/static/images/contentstack.png)](https://www.contentstack.com/)
## Contentstack Sync Utility Express Boilerplate

The Contentstack Sync is a remarkable utility for syncing your content and assets. This utility allows you to save your app data on a device’s local storage and then fetch incremental changes through timely sync operations. After its first syncs data, the system delivers only the content that was changed since the last sync.
Contentstack is a headless CMS with an API-first approach. It is a CMS that developers can use to build powerful cross-platform applications in their favorite languages. Build your application frontend, and Contentstack will take care of the rest. [Read More](https://www.contentstack.com/).

The SDK boilerplate allows you to create a website from the data that you synced through this utility. We have created step-by-step documentation to help you create a web page from the synced data. Based on the steps provided, you can create different pages for your website by following similar steps. Read it [here](https://www.contentstack.com/docs/tools-and-frameworks/contentstack-sync/nodejs-app-using-contentstack-sync).
## Contentstack DataSync Express SDK Boilerplate

Contentstack DataSync lets you sync your Contentstack data with your database, enabling you to save data locally and serve content directly from your database. It is a combination of four powerful modules that is [DataSync Webhook Listener](https://github.com/contentstack/webhook-listener), [DataSync Manager](https://github.com/contentstack/datasync-manager), [DataSync Asset Store Filesystem](https://github.com/contentstack/datasync-asset-store-filesystem), **DataSync Content Store** — [Filesystem](https://github.com/contentstack/datasync-content-store-filesystem) and [MongoDB](https://github.com/contentstack/datasync-content-store-mongodb).

The boilerplate allows you to create a website from the data that you synced through this utility. We have created step-by-step documentation to help you create a web page from the synced data. Based on the steps provided, you can create different pages for your website by following similar steps. Read it [here](https://www.contentstack.com/docs/example-apps/example-website-using-contentstack-datasync).

## Further Reading

- [Getting started with Contentstack DataSync](https://www.contentstack.com/docs/guide/synchronization/contentstack-datasync)
- [Contentstack DataSync](https://www.contentstack.com/docs/guide/synchronization/contentstack-datasync/configuration-files-for-contentstack-datasync) doc lists the configuration for different modules

## Support and Feature requests
If you have any issues working with the library, please file an issue [here](https://github.com/contentstack/datasync-ecommerce-website-example/issues) at Github.

You can send us an e-mail at support@contentstack.com if you have any support or feature requests. Our support team is available 24/7 on the intercom. You can always get in touch and give us an opportunity to serve you better!

## License
This repository is published under the [MIT license](LICENSE).
2 changes: 1 addition & 1 deletion config/development.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
const config = {
sdk: 'contentstack-sync-filesystem-sdk',
sdk: 'datasync-filesystem-sdk',
contentstack: {
apikey: '',
deliveryToken: '',
Expand Down
Binary file not shown.
Binary file removed modules/contentstack-sync-mongodb-sdk-1.0.0.tgz
Binary file not shown.
19 changes: 13 additions & 6 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,24 +1,31 @@
{
"name": "my-project",
"version": "0.0.0",
"name": "datasync-express-sdk-boilerplate",
"version": "0.0.1",
"private": true,
"scripts": {
"start": "node ./bin/www"
},
"dependencies": {
"contentstack-sync-mongodb-sdk": "file:modules/contentstack-sync-mongodb-sdk-1.0.0.tgz",
"contentstack-sync-filesystem-sdk": "file:modules/contentstack-sync-filesystem-sdk-0.0.1.tgz",
"async": "^2.6.1",
"path": "^0.12.7",
"contentstack": "^3.4.1",
"datasync-filesystem-sdk": "git+https://github.com/contentstack/datasync-filesystem-sdk.git",
"datasync-mongodb-sdk": "git+https://github.com/contentstack/datasync-mongodb-sdk.git",
"debug": "~2.6.9",
"express": "~4.16.0",
"http-errors": "~1.6.2",
"morgan": "~1.9.0",
"npm-git-install": "^0.3.0",
"nunjucks": "^3.1.3",
"path": "^0.12.7",
"request": "^2.87.0"
},
"devDependencies": {
"eslint": "^5.13.0"
}
},
"repository": {
"type": "git",
"url": "https://github.com/contentstack/datasync-nodejs-website-boilerplate"
},
"author": "Contentstack LLC <support@contentstack.com>",
"license": "MIT"
}