mirror of
https://github.com/standardnotes/app.git
synced 2026-01-11 19:56:41 +00:00
75 lines
3.1 KiB
Markdown
75 lines
3.1 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/discord)
|
||
[](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.
|
||
- Public source code with ability to self-host your own server in a [few easy steps](https://standardnotes.com/help/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://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://standardnotes.com/forum)
|
||
|
||
Developers can create and publish their own extensions. Visit the [documentation hub](https://standardnotes.com/help/plugins/intro) to learn more.
|
||
|
||
Questions? Find answers on our [Help page](https://standardnotes.com/help).
|
||
|
||
---
|
||
|
||
### Self-hosting the web app
|
||
|
||
Our web app is compiled into a folder of static HTML, JS, and CSS files. You can serve these files behind a web server to get started:
|
||
|
||
1. `git clone https://github.com/standardnotes/app.git`
|
||
2. `cd app`
|
||
3. `yarn install`
|
||
4. `yarn build:web`
|
||
5. `cd packages/web`
|
||
6. You can then use Python to serve this folder over http: `python -m http.server 8080`
|
||
|
||
You can now access the app at `http://localhost:8080`.
|
||
|
||
### 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
|
||
```
|