https://github.com/standardnotes/syncing-server-js
The Standard Notes server. For self-hosting, use https://github.com/standardnotes/standalone
https://github.com/standardnotes/syncing-server-js
Last synced: 11 months ago
JSON representation
The Standard Notes server. For self-hosting, use https://github.com/standardnotes/standalone
- Host: GitHub
- URL: https://github.com/standardnotes/syncing-server-js
- Owner: standardnotes
- License: agpl-3.0
- Archived: true
- Created: 2020-11-04T13:08:20.000Z (over 5 years ago)
- Default Branch: develop
- Last Pushed: 2022-06-17T06:59:38.000Z (over 3 years ago)
- Last Synced: 2024-07-09T01:19:35.856Z (over 1 year ago)
- Language: TypeScript
- Homepage:
- Size: 1.71 MB
- Stars: 71
- Watchers: 8
- Forks: 13
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.txt
Awesome Lists containing this project
README
# Standard Notes Syncing Server
You can run your own Standard Notes server and use it with any Standard Notes app. This allows you to have 100% control of your data. This server is built with TypeScript and can be deployed in minutes.
**Requirements**
- Docker
**Data persistency**
Your MySQL Data will be written to your local disk in the `data` folder to keep it persistent between server runs.
### Getting started
1. Clone the project:
```
git clone --branch main https://github.com/standardnotes/syncing-server-js.git
```
1. Setup the server by running:
```
./server.sh setup
```
1. Run the server by typing:
```
./server.sh start
```
Your server should now be available under http://localhost:3000
**Note**: When running the server locally it is by default ran in a Hot Reload Mode. This means that every time you change any of the source files locally the server is restarted to reflect the changes. This is in particular helpful when doing local development.
### Logs
You can check the logs of the running server by typing:
```
./server.sh logs
```
### Stopping the Server
In order to stop the server type:
```
./server.sh stop
```
### Updating to latest version
In order to update to the latest version of our software type:
```
./server.sh update
```
### Checking Status
You can check the status of running services by typing:
```
./server.sh status
```
### Cleanup Data
Please use this step with caution. In order to remove all your data and start with a fresh environment please type:
```
./server.sh cleanup
```
### Tests
To execute all of the test specs, run the following command at the root of the project directory:
```bash
yarn test
```