web/README.md

73 lines
3.0 KiB
Markdown
Raw Normal View History

2018-03-02 19:18:41 +03:00
# Standard Notes
2017-01-03 09:16:00 +03:00
2022-06-30 06:33:38 +03:00
Standard Notes is an end-to-end encrypted note-taking app for digitalists and professionals. Capture your notes, files, and lifes work all in one secure place.
2017-01-03 09:16:00 +03:00
2022-07-03 16:01:57 +03:00
[![latest release version](https://img.shields.io/github/v/release/standardnotes/app)](https://github.com/standardnotes/app/releases)
2022-11-14 21:01:37 +03:00
[![Discord](https://img.shields.io/badge/discord-standardnotes-CC2B5E.svg?style=flat&logo=discord)](https://standardnotes.com/discord)
[![Twitter Follow](https://img.shields.io/badge/follow-%40standardnotes-blue.svg?style=flat&logo=twitter)](https://twitter.com/standardnotes)
2018-03-02 19:18:02 +03:00
### Why Standard Notes?
2017-01-03 09:16:00 +03:00
2022-06-30 06:33:38 +03:00
- End-to-end encrypted sync. Only you can read your notes.
- Fast, free, and encrypted cross-platform sync on unlimited devices.
- Open-source with ability to self-host your own server in a [few easy steps](https://standardnotes.com/help/self-hosting/getting-started).
2021-06-28 21:28:01 +03:00
- A strong focus on longevity and sustainability. [Learn more](https://standardnotes.com/longevity).
2016-12-14 02:22:39 +03:00
2018-03-02 19:18:02 +03:00
### Creating your private notes account
2017-01-03 09:16:00 +03:00
2021-08-31 11:13:52 +03:00
1. Launch the web app at [app.standardnotes.com](https://app.standardnotes.com).
2018-03-02 19:18:02 +03:00
2. Click Register to create your private notes account.
2022-06-30 06:33:38 +03:00
3. Download Standard Notes on your devices.
- [Mac](https://standardnotes.com/download)
- [Windows](https://standardnotes.com/download)
- [Linux](https://standardnotes.com/download)
2021-06-28 21:28:01 +03:00
- [iOS](https://standardnotes.com/download/https://itunes.apple.com/us/app/standard-notes/id1285392450?mt=8)
2018-03-02 19:18:02 +03:00
- [Android](https://play.google.com/store/apps/details?id=com.standardnotes)
2022-06-30 06:33:38 +03:00
4. You're all set. Standard Notes comes out of the box with end-to-end encrypted sync on all your devices.
2018-03-02 19:18:02 +03:00
### Publish a Blog
2022-06-30 06:33:38 +03:00
Standard Notes is a dependable environment to do your most important work, including publishing your ideas to the world. Listed allows you to create an online publication with automatic email newsletters delivered to your readers, directly from Standard Notes.
2018-03-02 19:18:02 +03:00
[Learn more about Listed.](https://listed.to/)
2022-06-30 06:33:38 +03:00
### Community
2018-03-02 19:18:02 +03:00
2022-06-30 06:33:38 +03:00
Join us on
- [Discord](https://standardnotes.com/discord)
2022-07-03 16:01:57 +03:00
- [Twitter](https://twitter.com/StandardNotes)
2023-01-10 21:15:18 +03:00
- [Forum](https://standardnotes.com/forum)
2018-03-02 19:18:02 +03:00
Developers can create and publish their own extensions. Visit the [documentation hub](https://standardnotes.com/help/plugins/intro) to learn more.
2018-03-02 19:18:02 +03:00
2021-06-28 21:28:01 +03:00
Questions? Find answers on our [Help page](https://standardnotes.com/help).
2018-03-02 19:18:02 +03:00
---
2020-09-01 17:16:40 +03:00
### Docker setup
2020-08-10 09:51:56 +03:00
2022-06-30 06:33:38 +03:00
Docker is the quickest way to try out Standard Notes. We recommend using our official [Docker hub image](https://hub.docker.com/repository/docker/standardnotes/web).
2020-09-01 17:16:40 +03:00
```
2022-06-30 06:33:38 +03:00
docker run -d -p 3001:3001 --env-file=.env.sample standardnotes/web:stable
2020-09-01 17:16:40 +03:00
```
2022-06-30 06:33:38 +03:00
You can then access the app at `http://localhost:3001`. It may take a minute for the server to start up.
2020-08-10 09:51:56 +03:00
2022-07-03 16:01:57 +03:00
### Running Web App in Development Mode
2018-03-02 19:18:02 +03:00
2. Clone the repo
3. `yarn install`
2022-07-03 16:01:57 +03:00
4. `yarn build:web`
5. `cd packages/web && yarn start`
2022-06-30 06:33:38 +03:00
6. Open your browser to `http://localhost:3001`.
2018-03-02 19:18:02 +03:00
2018-08-05 17:42:57 +03:00
---
2022-06-30 06:33:38 +03:00
You can configure the `DEFAULT_SYNC_SERVER` environment variable to set the default server for login and registration.
2018-08-05 17:42:57 +03:00
```
DEFAULT_SYNC_SERVER=https://sync.myserver
2018-08-05 17:42:57 +03:00
```