https://github.com/electerm/electerm-sync-server-node
A nodejs server to sync electerm data
https://github.com/electerm/electerm-sync-server-node
Last synced: about 2 months ago
JSON representation
A nodejs server to sync electerm data
- Host: GitHub
- URL: https://github.com/electerm/electerm-sync-server-node
- Owner: electerm
- License: mit
- Created: 2022-05-25T06:25:00.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2025-11-16T05:13:09.000Z (5 months ago)
- Last Synced: 2025-11-16T07:07:10.650Z (5 months ago)
- Language: JavaScript
- Size: 151 KB
- Stars: 4
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Nodejs Electerm sync server
[](https://github.com/electerm/electerm-sync-server-node/actions)
A simple electerm data sync server.
## Use
Requires git/nodejs 16+/npm, recommend install nodejs/npm with [nvm](https://github.com/nvm-sh/nvm)
```bash
git clone git@github.com:electerm/electerm-sync-server-node.git
cd electerm-sync-server-node
npm i
# create env file, then edit .env
cp sample.env .env
node src/server.js
# would show something like
# server running at http://127.0.0.1:7837
# Then you can use http://127.0.0.1:7837/api/sync as API Url in electerm custom sync
# in electerm sync settings, set custom sync server with:
# server url: http://127.0.0.1:7837
# JWT_SECRET: your JWT_SECRET in .env
# JWT_USER_NAME: one JWT_USER in .env
```
## Test
```bash
# create env file, then edit .env
cp sample.env .env
npm run test
```
## Write your own data store
Just take [src/file-store.js](src/file-store.js) as an example, write your own read/write method
## Sync server in other languages
- [electerm-sync-server-kotlin](https://github.com/electerm/electerm-sync-server-kotlin)
- [electerm-sync-server-vercel](https://github.com/electerm/electerm-sync-server-vercel)
- [electerm-sync-server-rust](https://github.com/electerm/electerm-sync-server-rust)
- [electerm-sync-server-cpp](https://github.com/electerm/electerm-sync-server-cpp)
- [electerm-sync-server-java](https://github.com/electerm/electerm-sync-server-java)
- [electerm-sync-server-node](https://github.com/electerm/electerm-sync-server-node)
- [electerm-sync-server-python](https://github.com/electerm/electerm-sync-server-python)
- [electerm-sync-server-deno](https://github.com/electerm/electerm-sync-server-deno)
- [electerm-sync-server-go](https://github.com/electerm/electerm-sync-server-go)
## License
MIT