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

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

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.

(back to top)

Built With

Frontend

• 
• 
• 
• 
• 

Backend

• 

• 

• 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)

(back to top)

Getting Started

TO get started, please visit the compile guide on the wiki.

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 here.

(back to top)

Usage

The documentation is hosted on the project's main repository wiki.

(back to top)

Roadmap

• Basic workspace system
• Translation
  • ZH-CN: 100%.
  • EN-US: 100%, fallback language.

See the open issues for a full list of proposed features (and known issues).

(back to top)

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

(back to top)

Top contributors:

License

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

(back to top)

Contact

Please reach out me using the issue on GitLb, please note that the GitHub repository is just a mirror.

(back to top)

Acknowledgments

• othneildrew / Best-README-Template

(back to top)