89 lines
3.6 KiB
Markdown
89 lines
3.6 KiB
Markdown
# Standard Notes
|
||
|
||
Standard Notes is an end-to-end encrypted note-taking app for digitalists and professionals. Capture your notes, files, and life’s work all in one secure place.
|
||
|
||
[](https://github.com/standardnotes/app/releases)
|
||
[](https://standardnotes.com/slack)
|
||
[](https://twitter.com/standardnotes)
|
||
|
||
### Why Standard Notes?
|
||
|
||
- 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://docs.standardnotes.com/self-hosting/getting-started).
|
||
- A strong focus on longevity and sustainability. [Learn more](https://standardnotes.com/longevity).
|
||
|
||
### Creating your private notes account
|
||
|
||
1. Launch the web app at [app.standardnotes.com](https://app.standardnotes.com).
|
||
2. Click Register to create your private notes account.
|
||
3. Download Standard Notes on your devices.
|
||
- [Mac](https://standardnotes.com/download)
|
||
- [Windows](https://standardnotes.com/download)
|
||
- [Linux](https://standardnotes.com/download)
|
||
- [iOS](https://standardnotes.com/download/https://itunes.apple.com/us/app/standard-notes/id1285392450?mt=8)
|
||
- [Android](https://play.google.com/store/apps/details?id=com.standardnotes)
|
||
4. You're all set. Standard Notes comes out of the box with end-to-end encrypted sync on all your devices.
|
||
|
||
### Publish a Blog
|
||
|
||
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.
|
||
|
||
[Learn more about Listed.](https://listed.to/)
|
||
|
||
### Community
|
||
|
||
Join us on
|
||
|
||
- [Discord](https://standardnotes.com/discord)
|
||
- [Twitter](https://twitter.com/StandardNotes)
|
||
- [Forum](https://forum.standardnotes.org)
|
||
- [Slack](https://standardnotes.com/slack)
|
||
|
||
Developers can create and publish their own extensions. Visit the [documentation hub](https://docs.standardnotes.com/) to learn more.
|
||
|
||
Questions? Find answers on our [Help page](https://standardnotes.com/help).
|
||
|
||
---
|
||
|
||
### Docker setup
|
||
|
||
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).
|
||
|
||
```
|
||
docker run -d -p 3001:3001 --env-file=.env.sample standardnotes/web:stable
|
||
```
|
||
|
||
You can then access the app at `http://localhost:3001`. It may take a minute for the server to start up.
|
||
|
||
### Running Web App in Development Mode
|
||
|
||
2. Clone the repo
|
||
3. `yarn install`
|
||
4. `yarn build:web`
|
||
5. `cd packages/web && yarn start`
|
||
6. Open your browser to `http://localhost:3001`.
|
||
|
||
---
|
||
|
||
You can configure the `DEFAULT_SYNC_SERVER` environment variable to set the default server for login and registration.
|
||
|
||
```
|
||
DEFAULT_SYNC_SERVER=https://sync.myserver
|
||
```
|
||
|
||
## Running E2E tests
|
||
|
||
In order to run a stable server environment for E2E tests that will is up to date with what we have on production please checkout locally the [e2e repository](https://github.com/standardnotes/e2e).
|
||
|
||
To start the server type in the e2e repository:
|
||
```
|
||
yarn install --immutable
|
||
yarn test:stable-server
|
||
```
|
||
|
||
Then once the whole server infra is up and ready for your tests you can run the e2e suite in the local browser by typing (make sure you have built all the packages beforehand):
|
||
```
|
||
yarn start:server:e2e
|
||
```
|