BatNoter Takes Notes Directly to Your Private Git Repo
An open source, markdown-based, self-hosted note taking webapp.
BatNoter, is an outstanding a web application that allows users to write and store notes in their git repository!
This frontend project is built using React (TypeScript), Redux Toolkit, and MUI components. The BatNoter API serves as the backend implementation of REST APIs used by this React app.
What can you do with BatNoter?
With BatNoter, you can easily create, edit, delete, organize, and explore notes through a clean and user-friendly interface.
The application supports Markdown format, allowing you to add hyperlinks, tables, headings, code blocks, blockquotes, and more within your notes. The editor also provides a preview of your markdown content. In addition, you can quickly copy code from the code section using the "copy to clipboard" button.
Easily Organize your Notes.
BatNoter offers great flexibility when it comes to organizing your notes. You can choose to store them directly at the root level or create folders to nest your notes. With just a single click, you can explore all the notes within a specific directory.
Where are your notes stored?
All your notes are securely stored inside your GitHub repository. To enhance performance, notes are cached to minimize API calls.
You can bookmark URLs for easy access and switch between Dark and Light modes according to your preference.
Features
- User authentication is done through the GitHub login system, ensuring secure access to the application.
- The editor provides the convenient feature of allowing users to preview their markdown content before saving it.
- To ensure that the user's notes are easily accessible and can be accessed from any device, all notes are stored securely inside the user's GitHub repository.
- The application efficiently caches the notes, eliminating the need for additional API calls and providing a faster and smoother user experience.
- Users have the option to bookmark specific URLs within their notes, making it easier to navigate and refer back to important information.
- The application offers a customizable interface with both dark and light mode options, allowing users to choose their preferred visual theme for a comfortable reading and editing experience.
- Store notes directly at the root or use folders to organize them (nesting supported).
- Explore all the notes from a specific directory with single click.
- All the notes are stored inside user's github repository.
- Notes are cached to avoid additional API calls.
- URLs can be bookmarked.
Tech stack
- Node.js
- React
License
- MIT License
Resources
batnoter
