{"id":13457372,"url":"https://github.com/batnoter/batnoter","last_synced_at":"2025-05-15T12:05:27.015Z","repository":{"id":37032118,"uuid":"468643443","full_name":"batnoter/batnoter","owner":"batnoter","description":"An open source, markdown-based, self-hosted note taking webapp.","archived":false,"fork":false,"pushed_at":"2022-10-01T08:12:00.000Z","size":6583,"stargazers_count":2379,"open_issues_count":21,"forks_count":145,"subscribers_count":25,"default_branch":"main","last_synced_at":"2025-04-14T22:18:32.111Z","etag":null,"topics":["container-ready","contributions-welcome","git","github","markdown","mui","note","note-app","note-taking","notes","productivity","react","reactjs","typescript","webapp"],"latest_commit_sha":null,"homepage":"https://batnoter.com","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/batnoter.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"github":"vivekweb2013"}},"created_at":"2022-03-11T06:59:14.000Z","updated_at":"2025-04-14T15:30:03.000Z","dependencies_parsed_at":"2022-08-08T19:01:09.122Z","dependency_job_id":null,"html_url":"https://github.com/batnoter/batnoter","commit_stats":null,"previous_names":["git-noter/gitnoter"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/batnoter%2Fbatnoter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/batnoter%2Fbatnoter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/batnoter%2Fbatnoter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/batnoter%2Fbatnoter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/batnoter","download_url":"https://codeload.github.com/batnoter/batnoter/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254337613,"owners_count":22054253,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["container-ready","contributions-welcome","git","github","markdown","mui","note","note-app","note-taking","notes","productivity","react","reactjs","typescript","webapp"],"created_at":"2024-07-31T08:01:41.627Z","updated_at":"2025-05-15T12:05:22.000Z","avatar_url":"https://github.com/batnoter.png","language":"TypeScript","readme":"\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://batnoter.com\"\u003e\n    \u003cimg src=\"https://raw.githubusercontent.com/batnoter/batnoter/main/public/logo.svg\" width=\"100\"\u003e\n  \u003c/a\u003e\n\n  \u003cp align=\"center\"\u003e\n    Create and store notes to your git repository!\n    \u003cbr\u003e\n    \u003ca href=\"https://batnoter.com\"\u003e\u003cstrong\u003ehttps://batnoter.com\u003c/strong\u003e\u003c/a\u003e\n  \u003c/p\u003e\n\u003c/p\u003e\n\n## BatNoter\n\n[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/batnoter/batnoter/Test/main?color=forestgreen)](https://github.com/batnoter/batnoter/actions?query=branch%3Amain)\n[![codecov](https://codecov.io/gh/batnoter/batnoter/branch/main/graph/badge.svg?token=P40BDKYDBI)](https://codecov.io/gh/batnoter/batnoter)\n[![Codacy Badge](https://app.codacy.com/project/badge/Grade/824dc3f42ddf48f0b99194ea0ef975a7)](https://www.codacy.com/gh/batnoter/batnoter/dashboard?utm_source=github.com\u0026amp;utm_medium=referral\u0026amp;utm_content=batnoter/batnoter\u0026amp;utm_campaign=Badge_Grade)\n\n[BatNoter](https://batnoter.com) 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 \u0026 mui components. [BatNoter API](https://github.com/batnoter/batnoter-api) is the backend implementation of REST APIs which are used by this react app.\n\n\u003cp align=\"center\"\u003e\n  \u003ckbd\u003e\u003cimg src=\"https://raw.githubusercontent.com/batnoter/batnoter/main/public/demo.gif\" alt=\"BatNoter Demo\"/\u003e\u003c/kbd\u003e\n\u003c/p\u003e\n\n### Features\n-   Login with GitHub.\n-   Create, edit, delete, organize \u0026 explore notes easily with a nice \u0026 clean user interface.\n-   Markdown format supported allowing users to add hyperlink, table, headings, code blocks, blockquote... etc inside notes.\n-   Editor allows preview of markdown.\n-   Quickly copy code from the code section using copy to clipboard button.\n-   Store notes directly at the root or use folders to organize them (nesting supported).\n-   Explore all the notes from a specific directory with single click.\n-   All the notes are stored inside user's github repository.\n-   Notes are cached to avoid additional API calls.\n-   URLs can be bookmarked.\n-   Dark/Light mode supported.\n\n### Local Development Setup\n\n#### Prerequisites\n*   Node.js version `18` or above\n\n#### Start the server\n```shell\nnpm install\nnpm start\n```\nThis will start the react app in the development mode. Open [http://localhost:3000](http://localhost:3000) to view it in the browser.\n\n#### Run tests\n```shell\nnpm test\n```\nThis will execute all the tests and also prints the code coverage percentage.\n\n### Contribution Guidelines\n\u003e Every Contribution Makes a Difference\n\nRead the [Contribution Guidelines](CONTRIBUTING.md) before you contribute.\n\n### Contributors\nThanks goes to these wonderful people 🎉\n\n[![](https://opencollective.com/batnoter/contributors.svg?width=890\u0026button=false)](https://github.com/batnoter/batnoter/graphs/contributors)\n","funding_links":["https://github.com/sponsors/vivekweb2013"],"categories":["TypeScript","HarmonyOS","webapp"],"sub_categories":["Windows Manager"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbatnoter%2Fbatnoter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbatnoter%2Fbatnoter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbatnoter%2Fbatnoter/lists"}