{"id":19947397,"url":"https://github.com/arunk140/quillnote-server","last_synced_at":"2025-05-03T18:30:33.881Z","repository":{"id":71412182,"uuid":"570218367","full_name":"arunk140/quillnote-server","owner":"arunk140","description":"Runs a lightweight Nextcloud-like Notes Server. Made for the Quillnote/Quillpad App - https://qosp.org/ OR https://github.com/quillpad/quillpad ","archived":false,"fork":false,"pushed_at":"2024-04-03T01:23:41.000Z","size":29,"stargazers_count":11,"open_issues_count":2,"forks_count":1,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-04-03T02:34:55.334Z","etag":null,"topics":["docker","golang","nextcloud","note-taking","notes","self-hosted"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/arunk140.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}},"created_at":"2022-11-24T15:59:34.000Z","updated_at":"2024-03-19T14:02:47.000Z","dependencies_parsed_at":null,"dependency_job_id":"54e7d3aa-134a-4f9a-b130-ffba323cf201","html_url":"https://github.com/arunk140/quillnote-server","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arunk140%2Fquillnote-server","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arunk140%2Fquillnote-server/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arunk140%2Fquillnote-server/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arunk140%2Fquillnote-server/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/arunk140","download_url":"https://codeload.github.com/arunk140/quillnote-server/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224370249,"owners_count":17299968,"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":["docker","golang","nextcloud","note-taking","notes","self-hosted"],"created_at":"2024-11-13T00:35:55.667Z","updated_at":"2024-11-13T00:35:56.361Z","avatar_url":"https://github.com/arunk140.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# quillnote-server \n### currently in development things might break\n\n\nRuns a lightweight Nextcloud-like Notes Server. \n\nMade for the Quillnote/Quillpad App -\n\n* Maintained Fork - https://github.com/quillpad/quillpad \n* Orignal App - [Quillnote](https://github.com/msoultanidis/quillnote))\n\n## Purpose\n\nUse the Sync feature of Quillnote app without a full Nextcloud Instance. \nThis server emulates all the required APIs for \"Notes\" from NextCloud.\n\nCurrently the notes data is stored in an sqlite db.\n\n\n## Setup\n\n#### Clone Repo\n\n```\ngit clone https://github.com/arunk140/quillnote-server.git\ncd quillnote-server\n```\n\n### With Docker \n\n#### Build Docker Image\n\n```\ndocker build -f \"Dockerfile\" -t quillnoteserver:latest \".\"\n```\n\n#### Run Docker Container\n\n```\ndocker run -d  -p 3000:3000/tcp quillnoteserver:latest\n```\n\n#### Add User using a Bash Shell in the Container (Optional)\n\nNew Users can be created automatically just by logging through the Quillnote/Quillpad App - just choose a username and password when setting up sync settings in the App and a new Account will be created. - This feature should be togglable in the future with an enviroment variable.\n\n```\ndocker exec -it [container-name/id] sh\n./server user add [username] [password]\n```\n\n\n\n### Without Docker\n\n#### Build\n\n```\ngo build -o server .\n```\n\n#### Init DB (required)\n```\n./server migrate\n```\n\n\n#### Create User (Optional)\n\nNew Users can be created automatically just by logging through the Quillnote/Quillpad App - just choose a username and password when setting up sync settings in the App and a new Account will be created. - This feature should be togglable in the future with an enviroment variable.\n\n```\n./server user add [username] [password]\n```\n\n#### Run Server\n\n```\n./server\n```\n\n\n### Quillnote/Quillpad App\n\n* Maintained Fork - https://github.com/quillpad/quillpad \n* Orignal App - https://qosp.org/\n\nIn the `Settings` -\u003e `Go to sync settings` -\u003e Set the `Syncing service` to 'Nextcloud' \n\nIn the `Nextcloud Instance URL` add the IP:PORT or the URL for this quillnote-server and for the `Nextcloud account` use the username and password you used when adding an account to the server in the server setup.\n\n---\n\n## TODO \n\n* Testing \n* Push built Docker Image to a Image Repository\n* Add docker-compose\n* Add customizable Enviorment Variables \n    * Suport for Postgres/MySQL ... DBs\n    * HTTP Server Port and Listen Addr\n    * Enable/Disable Advanced Logging\n    * Enable/Disable /metrics Endpoint\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farunk140%2Fquillnote-server","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Farunk140%2Fquillnote-server","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farunk140%2Fquillnote-server/lists"}