{"id":21719921,"url":"https://github.com/z3t0/pkm","last_synced_at":"2025-03-20T20:52:49.159Z","repository":{"id":263725247,"uuid":"891287745","full_name":"z3t0/pkm","owner":"z3t0","description":null,"archived":false,"fork":false,"pushed_at":"2024-12-12T05:08:55.000Z","size":7445,"stargazers_count":0,"open_issues_count":11,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-25T18:30:36.915Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/z3t0.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-11-20T04:06:11.000Z","updated_at":"2024-12-13T16:57:44.000Z","dependencies_parsed_at":"2025-01-25T18:37:45.641Z","dependency_job_id":null,"html_url":"https://github.com/z3t0/pkm","commit_stats":null,"previous_names":["z3t0/pkm"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/z3t0%2Fpkm","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/z3t0%2Fpkm/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/z3t0%2Fpkm/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/z3t0%2Fpkm/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/z3t0","download_url":"https://codeload.github.com/z3t0/pkm/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244688457,"owners_count":20493815,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-26T01:43:11.454Z","updated_at":"2025-03-20T20:52:49.114Z","avatar_url":"https://github.com/z3t0.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# pkm\n\nA flexible, browser based note taking app.\n\nIt is in early development.\n\n![PKM Screenshot](./docs/pkm_screenshot.png)\n\nWIP Setting up a demo site: \n- https://z3t0.github.io/pkm/ \n- the site is not fully functional yet\n\n## Keybindings\n- Alt-x to open the command-bar\n- Ctr-o to search for a note\n\n## Features\n- Open multiple notes at once\n- Real-time syncing between devices\n- Rich text editor for notes (quill.js)\n- Generate links directly to a note\n- Embed links to other notes within a note. \n  - When clicked, the note opens in the same window, preventing a loss of context\n- Basic text search \n- Basic command bar for running specific actions\n- Basic window manager, allows you to look at multiple notes, searches etc at the same time.\n\n## Design Notes\n- Uses couchdb for the database in the cloud, synced to a local pouchdb in the browser.\n- There is no need for a backend, we're targetting a p2p architecture\n- Thus, the client is the full application.\n\n## Design Principles\n- Be fast. Don't frustrate the user by making them wait.\n- Keep the infrastructure simple\n  - Any user should be able to run the entire application by themselves if they wanted to.\n  \n## Other notes\n- Keep dependencies minimal.\n- Testing, documentation, examples are encouraged.\n\n## Setup developer environment\nRequirements:\n- Node\n- Docker\n- GNU/Linux environment\n- Python3\n\n\n### Running the database\nFirst time setup.\n\nThe script asks for sudo, when creating certain files with permissions.\nIt takes ~1 minute.\n```sh\ncd devDb\n./configure_db.sh\n```\n\nThen you can run the database\n```sh\n./start.sh\n```\n\n### Running the frontend\n```sh\ncd frontend\nnpm install\nnpm start\n```\n\nThe frontend should be running on http://localhost:8080\n\nYou can login using the test user credentials:\n- test@test.com\n- test123\n\n## Demo site\nThe demo site is deployed at https://z3t0.github.io/pkm/\n\nTo deploy manually:\n```sh\ncd frontend\nnpm install\nnpm run build:dev\nnpm run deploy:gh-pages\n```\n\nThis requires write access to the gh-pages branch on this repo.\n\n\nThe site is also automatically deployed with the CI.\nThe CI runs on all pushes at the moment.\nThis [issue](https://github.com/z3t0/pkm/issues/12) tracks a task to make the deployment only run for pushes on the main branch.\n\n\n## License\nAll first-party code in this repo is under AGPLv3 unless otherwise noted.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fz3t0%2Fpkm","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fz3t0%2Fpkm","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fz3t0%2Fpkm/lists"}