• 设为首页
  • 点击收藏
  • 手机版
    手机扫一扫访问
    迪恩网络手机版
  • 关注官方公众号
    微信扫一扫关注
    公众号

batnoter/batnoter: An open source, markdown-based, self-hosted note taking webap ...

原作者: [db:作者] 来自: 网络 收藏 邀请

开源软件名称(OpenSource Name):

batnoter/batnoter

开源软件地址(OpenSource Url):

https://github.com/batnoter/batnoter

开源编程语言(OpenSource Language):

TypeScript 96.2%

开源软件介绍(OpenSource Introduction):

Create and store notes to your git repository!
https://batnoter.com

BatNoter

GitHub Workflow Status codecov Codacy Badge

BatNoter is a web application that allows users to store notes in their git repository. This is a frontend project built using mainly react (typescript), redux-toolkit & mui components. BatNoter API is the backend implementation of REST APIs which are used by this react app.

BatNoter Demo

Features

  • Login with GitHub.
  • Create, edit, delete, organize & explore notes easily with a nice & clean user interface.
  • Markdown format supported allowing users to add hyperlink, table, headings, code blocks, blockquote... etc inside notes.
  • Editor allows preview of markdown.
  • Quickly copy code from the code section using copy to clipboard button.
  • 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.
  • Dark/Light mode supported.

Local Development Setup

Prerequisites

  • Node.js version 18 or above

Start the server

npm install
npm start

This will start the react app in the development mode. Open http://localhost:3000 to view it in the browser.

Run tests

npm test

This will execute all the tests and also prints the code coverage percentage.

Contribution Guidelines

Every Contribution Makes a Difference

Read the Contribution Guidelines before you contribute.

Contributors

Thanks goes to these wonderful people


鲜花

握手

雷人

路过

鸡蛋
该文章已有0人参与评论

请发表评论

全部评论

专题导读
热门推荐
阅读排行榜

扫描微信二维码

查看手机版网站

随时了解更新最新资讯

139-2527-9053

在线客服(服务时间 9:00~18:00)

在线QQ客服
地址:深圳市南山区西丽大学城创智工业园
电邮:jeky_zhao#qq.com
移动电话:139-2527-9053

Powered by 互联科技 X3.4© 2001-2213 极客世界.|Sitemap