# Pointer

**Repository Path**: MarcusP/Pointer

## Basic Information

- **Project Name**: Pointer
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-11-20
- **Last Updated**: 2025-11-20

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<!-- Template from Best-README-Template -->
<a id="readme-top"></a>



<!-- PROJECT SHIELDS -->
![GitLab Contributors](https://img.shields.io/gitlab/contributors/MarcusPy827%2FPointer?gitlab_url=https%3A%2F%2Fjihulab.com&style=plastic)
![GitLab Last Commit](https://img.shields.io/gitlab/last-commit/MarcusPy827%2FPointer?gitlab_url=https%3A%2F%2Fjihulab.com)
![License](https://img.shields.io/badge/License-Apache--2.0-blue)
![Made with love](https://img.shields.io/badge/Made_with-Love-red)

<!-- PROJECT LOGO -->
<br />
<div align="center">

<h3 align="center">Pointer</h3>

  <p align="center">
    A local note taking app that utilize Vite + React + TypeScript as front-end, and Node-Addon-API + Morden C++ as back-end.
    <br />
    <a href="https://jihulab.com/MarcusPy827/Pointer/-/wikis/home"><strong>Explore the docs »</strong></a>
    <br />
    <br />
    <a href="https://jihulab.com/MarcusPy827/Pointer/-/releases">Release Page</a>
    &middot;
    <a href="https://jihulab.com/MarcusPy827/Pointer/-/issues/new">Report Bug</a>
    &middot;
    <a href="https://jihulab.com/MarcusPy827/Pointer/-/issues/new">Request Feature</a>
  </p>
</div>



<!-- TABLE OF CONTENTS -->
<details>
  <summary>Table of Contents</summary>
  <ol>
    <li>
      <a href="#about-the-project">About The Project</a>
      <ul>
        <li><a href="#built-with">Built With</a></li>
      </ul>
    </li>
    <li>
      <a href="#getting-started">Getting Started</a>
      <ul>
        <li><a href="#prerequisites">Prerequisites</a></li>
        <li><a href="#installation">Installation</a></li>
      </ul>
    </li>
    <li><a href="#usage">Usage</a></li>
    <li><a href="#roadmap">Roadmap</a></li>
    <li><a href="#contributing">Contributing</a></li>
    <li><a href="#license">License</a></li>
    <li><a href="#contact">Contact</a></li>
    <li><a href="#acknowledgments">Acknowledgments</a></li>
  </ol>
</details>



<!-- ABOUT THE PROJECT -->
## About The Project

![Screen Shot](./docs/img/screenshot.png)

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.

<p align="right">(<a href="#readme-top">back to top</a>)</p>



### Built With
#### Frontend
* ![Vite](https://img.shields.io/badge/vite-%23646CFF?style=for-the-badge&logo=vite&logoColor=white)
* ![React](https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB)
* ![TypeScript](https://img.shields.io/badge/TypeScript-%233178C6?style=for-the-badge&logo=typescript&logoColor=white)
* ![Electron](https://img.shields.io/badge/Electron-%2347848F?style=for-the-badge&logo=electron&logoColor=white)
* ![Ant Design](https://img.shields.io/badge/Ant%20Design-%230170FE?style=for-the-badge&logo=antdesign&logoColor=white)

#### Backend

* ![C Plus Plus](https://img.shields.io/badge/C%2B%2B-%2300599C?style=for-the-badge&logo=cplusplus&logoColor=white)
* ![CMake](https://img.shields.io/badge/CMake-%23064F8C?style=for-the-badge&logo=cmake&logoColor=white)

* Library used
  * **MDUI (v1.0.2)**: Licensed under MIT, introduced via NPM.
  * **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.
  * **Protocol Buffers**: Licensed under BSD 3-Clause, introduced via package manager.
    (In the future, it will be statically linked)

<p align="right">(<a href="#readme-top">back to top</a>)</p>



<!-- GETTING STARTED -->
## Getting Started
TO get started, please visit the compile guide on the [wiki](https://jihulab.com/MarcusPy827/Pointer/-/wikis/en/Compile-Guide).

### 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
To build this program, you may refer the [wiki](https://jihulab.com/MarcusPy827/Pointer/-/wikis/en/Compile-Guide) here.

<p align="right">(<a href="#readme-top">back to top</a>)</p>



<!-- USAGE EXAMPLES -->
## Usage
The documentation is hosted on the project's main repository [wiki](https://jihulab.com/MarcusPy827/Pointer/-/wikis/).

<p align="right">(<a href="#readme-top">back to top</a>)</p>



<!-- ROADMAP -->
## Roadmap
- [ ] Basic workspace system
- [x] 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).

<p align="right">(<a href="#readme-top">back to top</a>)</p>



<!-- CONTRIBUTING -->
## 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

<p align="right">(<a href="#readme-top">back to top</a>)</p>

### Top contributors:

<a href="https://github.com/github_username/repo_name/graphs/contributors">
  <img src="https://contrib.rocks/image?repo=github_username/repo_name" alt="contrib.rocks image" />
</a>



<!-- LICENSE -->
## License

Distributed under the Apache License Version 2.0. See `LICENSE` file for more information.

<p align="right">(<a href="#readme-top">back to top</a>)</p>



<!-- CONTACT -->
## Contact
Please reach out me using the issue on GitLb, please note that the GitHub repository is just a mirror.

<p align="right">(<a href="#readme-top">back to top</a>)</p>



<!-- ACKNOWLEDGMENTS -->
## Acknowledgments
* othneildrew / Best-README-Template

<p align="right">(<a href="#readme-top">back to top</a>)</p>