Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/serenity-kit/serenity-notes-clients
End-to-end encrypted collaborative notes app
https://github.com/serenity-kit/serenity-notes-clients
Last synced: 3 months ago
JSON representation
End-to-end encrypted collaborative notes app
- Host: GitHub
- URL: https://github.com/serenity-kit/serenity-notes-clients
- Owner: serenity-kit
- License: agpl-3.0
- Created: 2021-02-05T23:32:20.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2023-07-19T06:20:45.000Z (over 1 year ago)
- Last Synced: 2024-04-14T16:28:26.627Z (7 months ago)
- Language: HTML
- Size: 2.98 MB
- Stars: 185
- Watchers: 4
- Forks: 9
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-list - serenity-notes-clients - to-end encrypted collaborative notes app | SerenityNotes | 153 | (TypeScript)
- awesome-starred - serenity-kit/serenity-notes-clients - End-to-end encrypted collaborative notes app (others)
README
# Serenity Notes iOS/Android/macOS
End-to-end encrypted collaborative notes app
[https://www.serenity.re/en/notes](https://www.serenity.re/en/notes)
Security & technical details are documented at [https://www.serenity.re/en/notes/technical-documentation](https://www.serenity.re/en/notes/technical-documentation).
## Setup & Development
```sh
npm i -g expo-cli
cd editor
yarn
# builds a index.html and copies it to app and desktop assets
yarn dist
cd ..
cd yjs
yarn
yarn dist
cd ..
# iOS/Android
cd app
yarn
# replace the API_URL in package.json with https://api.serenity.re/graphql
yarn start
# macOS
cd desktop
cd macos
npx pod-install
cd ..
# replace the API_URL in .env.development with https://api.serenity.re/graphql
npx react-native run-macos
```
## Mobile Builds
Creating build for iOS & Android.
```sh
cd app
yarn build:ios
yarn build:android
```
Creating a preview build for internal distribution.
```sh
cd app
yarn build:ios:preview
```
## macOS Release
Bump version in app.json & in Xcode in Target `serenity-macOS`.
Change build configuration to release https://reactnative.dev/docs/publishing-to-app-store#2-configure-release-scheme
```sh
cd desktop
yarn build-macos
```
Locate the .app file in `~/Library/Developer/Xcode/DerivedData//Build/Products/Release` and package it as dmg: `yarn create-dmg Serenity\ Notes.app`
Update the app version on the backend and the website link.
## License
Copyright 2021 Nikolaus Graf
Licensed under the [AGPLv3](https://www.gnu.org/licenses/agpl-3.0.html)