https://github.com/marcuspy827/pointer
A simple note taking app written with Vite + React + TypeScript + Electron
https://github.com/marcuspy827/pointer
Last synced: 10 months ago
JSON representation
A simple note taking app written with Vite + React + TypeScript + Electron
- Host: GitHub
- URL: https://github.com/marcuspy827/pointer
- Owner: MarcusPy827
- License: apache-2.0
- Created: 2025-08-21T08:29:41.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2025-08-31T21:07:08.000Z (10 months ago)
- Last Synced: 2025-08-31T22:19:11.729Z (10 months ago)
- Language: C++
- Size: 311 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Pointer
A local note taking app that utilize Vite + React + TypeScript as front-end, and Node-Addon-API + Morden C++ as back-end.
Explore the docs »
Release Page
·
Report Bug
·
Request Feature
Table of Contents
## About The Project
Pointer 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.
We 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.
### Built With
#### Frontend
* 
* 
* 
* 
* 
#### Backend
* 
* 
* Library used
* **Abseli**: Licensed under Apache-2.0, statically inked.
* **Google Test**: Licensed under BSD-3-Clause, statically linked.
* **nlohmann/json**: Licensed under MIT, header included in this repository.
* **mariusbancila/stduuid**: Licensed under MIT, header included in this repository.
## Getting Started
(WIP)
This is a simplified version, please refer to the documents in `docs` folder for full instructions.
### Prerequisites
You will need these two libraries in your environment path that CMake and gyp could find when compling the backend:
* Abseil
* Google Test
**Notice**: The headers of `nlohmann/json` and `mariusbancila/stduuid` is included in this repository, you don't need to clone & install them.
### Installation
#### Backend
```Shell
npm run backend:clean
npm run backend:configure
npm run backend:build
```
#### Frontend
For debugging purpose:
```Shell
npm run dev
```
For building:
```Shell
npm build:
```
...while `` is simply the platform that you are compling, for example:
```Shell
npm build:linux
```
Take Ubuntu as an example, after running the command you may gey four versions: linux unpacked, AppImage, .deb, snap.
## Usage
(WIP)
Please refer to the `docs` folder for usage guide.
## Roadmap
- [ ] Basic workspace system
- [ ] Translation
- [x] **ZH-CN**: 100%.
- [x] **EN-US**: 100%, fallback language.
See the [open issues](https://jihulab.com/MarcusPy827/Pointer/-/issues) for a full list of proposed features (and known issues).
## Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
If 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".
Don't forget to give the project a star! Thanks again!
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Merge Request
### Top contributors:
## License
Distributed under the Apache License Version 2.0. See `LICENSE` file for more information.
## Contact
Please reach out me using the issue on GitLb, please note that the GitHub repository is just a mirror.
## Acknowledgments
* othneildrew / Best-README-Template