{"id":30735860,"url":"https://github.com/marcuspy827/pointer","last_synced_at":"2025-09-03T20:52:12.992Z","repository":{"id":310967048,"uuid":"1041936453","full_name":"MarcusPy827/Pointer","owner":"MarcusPy827","description":"A simple note taking app written with Vite + React + TypeScript + Electron","archived":false,"fork":false,"pushed_at":"2025-08-31T21:07:08.000Z","size":318,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-08-31T22:19:11.729Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/MarcusPy827.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,"zenodo":null}},"created_at":"2025-08-21T08:29:41.000Z","updated_at":"2025-08-31T21:07:12.000Z","dependencies_parsed_at":"2025-08-21T10:44:23.504Z","dependency_job_id":"404698f4-955a-4c43-a0e4-ac263a62a923","html_url":"https://github.com/MarcusPy827/Pointer","commit_stats":null,"previous_names":["marcuspy827/pointer"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/MarcusPy827/Pointer","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MarcusPy827%2FPointer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MarcusPy827%2FPointer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MarcusPy827%2FPointer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MarcusPy827%2FPointer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MarcusPy827","download_url":"https://codeload.github.com/MarcusPy827/Pointer/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MarcusPy827%2FPointer/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273509218,"owners_count":25118447,"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","status":"online","status_checked_at":"2025-09-03T02:00:09.631Z","response_time":76,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":"2025-09-03T20:52:11.362Z","updated_at":"2025-09-03T20:52:12.978Z","avatar_url":"https://github.com/MarcusPy827.png","language":"C++","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003c!-- Template from Best-README-Template --\u003e\n\u003ca id=\"readme-top\"\u003e\u003c/a\u003e\n\n\n\n\u003c!-- PROJECT SHIELDS --\u003e\n![GitLab Contributors](https://img.shields.io/gitlab/contributors/MarcusPy827%2FPointer?gitlab_url=https%3A%2F%2Fjihulab.com\u0026style=plastic)\n![GitLab Last Commit](https://img.shields.io/gitlab/last-commit/MarcusPy827%2FPointer?gitlab_url=https%3A%2F%2Fjihulab.com)\n![License](https://img.shields.io/badge/License-Apache--2.0-blue)\n![Made with love](https://img.shields.io/badge/Made_with-Love-red)\n\n\u003c!-- PROJECT LOGO --\u003e\n\u003cbr /\u003e\n\u003cdiv align=\"center\"\u003e\n\n\u003ch3 align=\"center\"\u003ePointer\u003c/h3\u003e\n\n  \u003cp align=\"center\"\u003e\n    A local note taking app that utilize Vite + React + TypeScript as front-end, and Node-Addon-API + Morden C++ as back-end.\n    \u003cbr /\u003e\n    \u003ca href=\"docs\"\u003e\u003cstrong\u003eExplore the docs »\u003c/strong\u003e\u003c/a\u003e\n    \u003cbr /\u003e\n    \u003cbr /\u003e\n    \u003ca href=\"https://github.com/github_username/repo_name\"\u003eRelease Page\u003c/a\u003e\n    \u0026middot;\n    \u003ca href=\"https://github.com/github_username/repo_name/issues/new?labels=bug\u0026template=bug-report---.md\"\u003eReport Bug\u003c/a\u003e\n    \u0026middot;\n    \u003ca href=\"https://github.com/github_username/repo_name/issues/new?labels=enhancement\u0026template=feature-request---.md\"\u003eRequest Feature\u003c/a\u003e\n  \u003c/p\u003e\n\u003c/div\u003e\n\n\n\n\u003c!-- TABLE OF CONTENTS --\u003e\n\u003cdetails\u003e\n  \u003csummary\u003eTable of Contents\u003c/summary\u003e\n  \u003col\u003e\n    \u003cli\u003e\n      \u003ca href=\"#about-the-project\"\u003eAbout The Project\u003c/a\u003e\n      \u003cul\u003e\n        \u003cli\u003e\u003ca href=\"#built-with\"\u003eBuilt With\u003c/a\u003e\u003c/li\u003e\n      \u003c/ul\u003e\n    \u003c/li\u003e\n    \u003cli\u003e\n      \u003ca href=\"#getting-started\"\u003eGetting Started\u003c/a\u003e\n      \u003cul\u003e\n        \u003cli\u003e\u003ca href=\"#prerequisites\"\u003ePrerequisites\u003c/a\u003e\u003c/li\u003e\n        \u003cli\u003e\u003ca href=\"#installation\"\u003eInstallation\u003c/a\u003e\u003c/li\u003e\n      \u003c/ul\u003e\n    \u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#usage\"\u003eUsage\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#roadmap\"\u003eRoadmap\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#contributing\"\u003eContributing\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#license\"\u003eLicense\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#contact\"\u003eContact\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#acknowledgments\"\u003eAcknowledgments\u003c/a\u003e\u003c/li\u003e\n  \u003c/ol\u003e\n\u003c/details\u003e\n\n\n\n\u003c!-- ABOUT THE PROJECT --\u003e\n## About The Project\n\n![Screen Shot](./docs/img/screenshot.png)\n\nPointer is a note-taking app that aims to provide an elegant WYSIWYG markdown editing interface, using React + Electron for a modern user experience and modern C++ for backend.\n\nWe are committed to privacy protection. All data in this app is stored locally, and the developers do not have access to any of your data.\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\n\n### Built With\n#### Frontend\n* ![Vite](https://img.shields.io/badge/vite-%23646CFF?style=for-the-badge\u0026logo=vite\u0026logoColor=white)\n* ![React](https://img.shields.io/badge/React-20232A?style=for-the-badge\u0026logo=react\u0026logoColor=61DAFB)\n* ![TypeScript](https://img.shields.io/badge/TypeScript-%233178C6?style=for-the-badge\u0026logo=typescript\u0026logoColor=white)\n* ![Electron](https://img.shields.io/badge/Electron-%2347848F?style=for-the-badge\u0026logo=electron\u0026logoColor=white)\n* ![Ant Design](https://img.shields.io/badge/Ant%20Design-%230170FE?style=for-the-badge\u0026logo=antdesign\u0026logoColor=white)\n\n#### Backend\n\n* ![C Plus Plus](https://img.shields.io/badge/C%2B%2B-%2300599C?style=for-the-badge\u0026logo=cplusplus\u0026logoColor=white)\n* ![CMake](https://img.shields.io/badge/CMake-%23064F8C?style=for-the-badge\u0026logo=cmake\u0026logoColor=white)\n\n* Library used\n  * **Abseli**: Licensed under Apache-2.0, statically inked.\n  * **Google Test**: Licensed under BSD-3-Clause, statically linked.\n  * **nlohmann/json**: Licensed under MIT, header included in this repository.\n  * **mariusbancila/stduuid**: Licensed under MIT, header included in this repository.\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\n\n\u003c!-- GETTING STARTED --\u003e\n## Getting Started\n(WIP)\n\nThis is a simplified version, please refer to the documents in `docs` folder for full instructions.\n\n### Prerequisites\nYou will need these two libraries in your environment path that CMake and gyp could find when compling the backend:\n* Abseil\n* Google Test\n\n**Notice**: The headers of `nlohmann/json` and `mariusbancila/stduuid` is included in this repository, you don't need to clone \u0026 install them.\n\n### Installation\n#### Backend\n```Shell\nnpm run backend:clean\nnpm run backend:configure\nnpm run backend:build\n```\n\n#### Frontend\nFor debugging purpose:\n```Shell\nnpm run dev\n```\nFor building:\n```Shell\nnpm build:\u003cplatform\u003e\n```\n\n...while `\u003cplatform\u003e` is simply the platform that you are compling, for example:\n\n```Shell\nnpm build:linux\n```\n\nTake Ubuntu as an example, after running the command you may gey four versions:  linux unpacked, AppImage, .deb, snap.\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\n\n\u003c!-- USAGE EXAMPLES --\u003e\n## Usage\n(WIP)\n\nPlease refer to the `docs` folder for usage guide.\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\n\n\u003c!-- ROADMAP --\u003e\n## Roadmap\n- [ ] Basic workspace system\n- [ ] Translation\n  - [x] **ZH-CN**: 100%.\n  - [x] **EN-US**: 100%, fallback language.\n\nSee the [open issues](https://jihulab.com/MarcusPy827/Pointer/-/issues) for a full list of proposed features (and known issues).\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\n\n\u003c!-- CONTRIBUTING --\u003e\n## Contributing\n\nContributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.\n\nIf you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag \"enhancement\".\nDon't forget to give the project a star! Thanks again!\n\n1. Fork the Project\n2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)\n3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)\n4. Push to the Branch (`git push origin feature/AmazingFeature`)\n5. Open a Merge Request\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n### Top contributors:\n\n\u003ca href=\"https://github.com/github_username/repo_name/graphs/contributors\"\u003e\n  \u003cimg src=\"https://contrib.rocks/image?repo=github_username/repo_name\" alt=\"contrib.rocks image\" /\u003e\n\u003c/a\u003e\n\n\n\n\u003c!-- LICENSE --\u003e\n## License\n\nDistributed under the Apache License Version 2.0. See `LICENSE` file for more information.\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\n\n\u003c!-- CONTACT --\u003e\n## Contact\nPlease reach out me using the issue on GitLb, please note that the GitHub repository is just a mirror.\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\n\n\u003c!-- ACKNOWLEDGMENTS --\u003e\n## Acknowledgments\n* othneildrew / Best-README-Template\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarcuspy827%2Fpointer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmarcuspy827%2Fpointer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarcuspy827%2Fpointer/lists"}