anyproto/anytype-ts
1
0
Fork 0
mirror of https://github.com/anyproto/anytype-ts.git synced 2025-06-08 05:57:02 +09:00
Code Activity
Official Anytype client for MacOS, Linux, and Windows https://anytype.io
13696 commits 10 branches 726 tags 925 MiB
Find a file
developomp b61ee4d63b
tidy up linters & formatters
2023-08-04 13:08:54 +09:00
.github/workflows Merge pull request #142 from developomp/gh-workflow 2023-07-31 21:25:46 +02:00
.husky added npx to license-checker so it doesnt have to be installed globally 2023-04-14 15:39:07 +09:00
dist add locale back, remove debug 2023-08-02 12:08:01 +02:00
electron update translate method 2023-08-03 13:58:13 +02:00
patches keytar patch 2021-12-13 14:29:27 +03:00
src update translate method 2023-08-03 13:58:13 +02:00
.editorconfig add editorconfig 2023-07-27 11:29:23 +09:00
.eslintignore make prettier ignore css files 2023-07-26 23:14:41 +09:00
.eslintrc.js use tab indention for eslintrc file 2023-07-27 11:35:16 +09:00
.gitattributes .so lfs storage 2019-09-25 13:12:20 +03:00
.gitignore add table overview of moving the helper 2023-07-23 21:46:58 +02:00
check-licenses.js Update precommit checker 2023-05-22 17:34:15 +03:00
electron.js JS-2699: Localise about.html 2023-07-28 14:43:35 +02:00
js-anytype.code-workspace tidy up linters & formatters 2023-08-04 13:08:54 +09:00
LICENSE.md Update LICENSE.md 2023-07-24 09:39:52 +03:00
middleware.version bump middleware version 2023-07-19 10:05:13 +02:00
package-lock.json tidy up linters & formatters 2023-08-04 13:08:54 +09:00
package.deps.json fix graph font and source map 2023-06-16 21:29:09 +02:00
package.json tidy up linters & formatters 2023-08-04 13:08:54 +09:00
README.md fix blunder 2023-08-01 22:27:03 +09:00
save-node-deps.js JS-279: fix sed regex for windows 2022-09-09 08:40:50 +03:00
tsconfig.json some refactoring 2023-04-19 00:40:54 +09:00
update.sh update localisation build 2023-08-02 11:56:08 +02:00
webpack.config.js some refactoring 2023-04-19 00:40:54 +09:00
webpack.node.config.js fix build 2020-11-19 17:03:01 +03:00

README.md

Anytype

Official Anytype client for MacOS, Linux, and Windows.

Building the source

Dependencies

Debian-based (Ubuntu / Pop! OS / Mint / ... ):

apt install libsecret-1-dev

Fedora:

dnf install libsecret

Arch-based (Manjaro / EndeavourOS / ... ):

pacman -S libsecret

Alpine (usually for docker-related stuff):

apk add libsecret

Installation

git clone https://github.com/anyproto/anytype-ts
cd anytype-ts
npm install -D

Also, install gitleaks to ensure proper work of pre-commit hooks.

Install middleware library and protobuf bindings

Fetch the latest binary from the github releases.

Warning When building client from source be aware that middleware version in latest release may diverge from current client version, so it is highly recommended to build middleware from source as well.

./update.sh <macos-latest|ubuntu-latest|windows-latest> <arm|amd> # arm/amd only for macos/ubuntu

Or compile from the source code. Follow instructions at anytype-heart.

After ./update.sh downloaded the binary or after compiling it from source, you need to move anytypeHelper into the dist Folder.

OS CPU Type move command
Windows already copied to the dist folder
MacOS <arm | amd> mv darwin-*/anytypeHelper dist/
Linux <arm | amd> mv linux-*/anytypeHelper dist/

Building

Build anytype-heart first.

npm run dist:(mac|win|linux)

Options:

  • ELECTRON_SKIP_NOTARIZE=1 — skip MacOS notarization process

Running

Before running Anytype locally, you need to build anytype-heart.

MacOS, Linux

SERVER_PORT=<PORT> ANYPROF=:<PROFILER_PORT> npm run start:dev

Windows

SERVER_PORT=<PORT> ANYPROF=:<PROFILER_PORT> npm run start:dev-win

Options:

  • SERVER_PORT — NPM variable, local server port
  • ANYPROF — Go variable, profiler port, access http://localhost:<PORT>/debug/pprof/profile?seconds=30 for profiling

Localisation

npm run update:locale - Update localisation files

Contribution

Thank you for your desire to develop Anytype together!

❤️ This project and everyone involved in it is governed by the Code of Conduct.

🧑‍💻 Check out our contributing guide to learn about asking questions, creating issues, or submitting pull requests.

🫢 For security findings, please email security@anytype.io and refer to our security guide for more information.

🤝 Follow us on Github and join the Contributors Community.

Made by Any — a Swiss association 🇨🇭

Licensed under Any Source Available License 1.0.