Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/batnoter/batnoter
An open source, markdown-based, self-hosted note taking webapp.
https://github.com/batnoter/batnoter
container-ready contributions-welcome git github markdown mui note note-app note-taking notes productivity react reactjs typescript webapp
Last synced: about 1 month ago
JSON representation
An open source, markdown-based, self-hosted note taking webapp.
- Host: GitHub
- URL: https://github.com/batnoter/batnoter
- Owner: batnoter
- License: mit
- Created: 2022-03-11T06:59:14.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-10-01T08:12:00.000Z (about 2 years ago)
- Last Synced: 2024-05-21T11:56:37.918Z (6 months ago)
- Topics: container-ready, contributions-welcome, git, github, markdown, mui, note, note-app, note-taking, notes, productivity, react, reactjs, typescript, webapp
- Language: TypeScript
- Homepage: https://batnoter.com
- Size: 6.28 MB
- Stars: 2,300
- Watchers: 25
- Forks: 131
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome - batnoter/batnoter - An open source, markdown-based, self-hosted note taking webapp. (TypeScript)
- my-awesome - batnoter/batnoter - ready,contributions-welcome,git,github,markdown,mui,note,note-app,note-taking,notes,productivity,react,reactjs,typescript,webapp pushed_at:2022-10 star:2.4k fork:0.1k An open source, markdown-based, self-hosted note taking webapp. (TypeScript)
README
Create and store notes to your git repository!
https://batnoter.com
## BatNoter
[](https://github.com/batnoter/batnoter/actions?query=branch%3Amain)
[](https://codecov.io/gh/batnoter/batnoter)
[](https://www.codacy.com/gh/batnoter/batnoter/dashboard?utm_source=github.com&utm_medium=referral&utm_content=batnoter/batnoter&utm_campaign=Badge_Grade)
[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 & mui components. [BatNoter API](https://github.com/batnoter/batnoter-api) is the backend implementation of REST APIs which are used by this react app.
### 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
```shell
npm install
npm start
```
This will start the react app in the development mode. Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
#### Run tests
```shell
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](CONTRIBUTING.md) before you contribute.
### Contributors
Thanks goes to these wonderful people 🎉
[](https://github.com/batnoter/batnoter/graphs/contributors)