@burakboduroglu/penote 3.0.1

package/AGENTS.md

@@ -0,0 +1,223 @@
+# AGENTS.md
+
+> Guide for AI agents working in this repository.
+> Read this file before making any change.
+
+---
+
+## Project Summary
+
+**penote** (CLI: `penote`, npm: `@burakboduroglu/penote`) is an **agentic
+learning docs** library: programming notes in Markdown, organised by
+language/topic, reachable via a zero-dependency Node.js CLI and a
+browser-based Web UI.
+
+The GitHub repository, the npm scope and the CLI binary are all **penote**.
+
+- **No build step for the notes tooling.** Node.js 18+ is the only runtime
+  requirement for the published CLI and Web UI.
+- **Use `bun` for every local command** (`bun library/cli.js …`, `bun run dev`).
+  Never write `npm`, `pnpm`, or `yarn` in docs or scripts. The published binary
+  still targets Node.js built-ins, so do not introduce bun-only APIs.
+- **Content is king.** The value of this repo is in the `.md` notes, not the
+  tooling.
+- **CLI entry point:** `library/cli.js` (binary name: `penote`)
+- **Web UI entry point:** `library/index.html`
+- **Human-facing repo docs** (README, CONTRIBUTING, SECURITY, …) are English.
+  **Note bodies** stay Turkish (see below).
+
+---
+
+## Repository Structure
+
+```
+penote/                  # GitHub repo / local folder name
+├── Java-Notes/          # Lombok, JPA/Hibernate, Spring Boot
+├── Javascript-Notes/    # Array methods, closures, async, regex
+├── Python-Notes/        # Basics, advanced topics, DB operations
+├── SQL-Notes/           # Basic queries, advanced SQL, psql terminal
+├── MongoDB-Notes/       # Basic CRUD and querying
+├── library/
+│   ├── cli.js           # CLI tool (Node.js, no dependencies)
+│   └── index.html       # Web UI (vanilla HTML/JS/CSS)
+├── assets/
+│   ├── penote-logo.svg     # App icon; SVG is the source of truth
+│   ├── social-preview.svg  # GitHub link preview card (1280x640)
+│   ├── social-preview.png  # Rendered from the SVG; uploaded by hand
+│   ├── demo.svg            # README terminal card (1000x620)
+│   └── demo.png            # Rendered from the SVG
+├── .github/             # Issue forms, PR template, CI / publish workflows
+├── AGENTS.md
+├── CHANGELOG.md
+├── CODE_OF_CONDUCT.md
+├── CONTRIBUTING.md
+├── LICENSE
+├── README.md
+├── SECURITY.md
+└── package.json         # npm package metadata for `@burakboduroglu/penote`
+```
+
+---
+
+## Adding or Editing Notes
+
+### Naming Convention
+
+| Rule                                         | Example                                  |
+| -------------------------------------------- | ---------------------------------------- |
+| Lowercase, words separated by `_`            | `python_basic_1.md`                      |
+| Suffix with `_1`, `_2` for multi-part series | `sql_advanced_1.md`, `sql_advanced_2.md` |
+| Place in the correct category folder         | `Python-Notes/advanced_python_3.md`      |
+
+### Note file template
+
+Every new note should follow this shape:
+
+```markdown
+# Topic title
+
+> One-sentence Turkish summary of this note.
+
+---
+
+## Section 1
+
+Content here...
+
+## Section 2
+
+Content here...
+
+---
+
+**Kaynaklar**
+
+- Source or documentation link (if any)
+```
+
+### Note content rules
+
+- **Language: all notes must be written in Turkish.** Material taken from
+  English sources still needs Turkish explanation and summary. Technical terms
+  (`variable`, `function`, `query`, …) may stay in English; explanations must
+  be Turkish.
+- **When updating older English notes:** write the Turkish equivalent first,
+  then keep the technical content accurate.
+- **Code blocks:** always include a language identifier (```` ```java ````,
+  ```` ```python ````, etc.).
+- **No external images in notes.** If needed, use a relative path under
+  `assets/`.
+- **Stay focused:** one concept (or a tight related group) per file.
+- **No frontmatter (YAML/TOML):** the CLI parses plain Markdown only.
+
+---
+
+## Working with the CLI (`library/cli.js`)
+
+### What the CLI does
+
+- Reads all `.md` files from the category folders.
+- Provides list, search, open (editor / TUI / browser), and help commands.
+- Parses file paths to derive category and note name — **folder and file naming
+  directly affects CLI output.**
+
+### Rules when modifying `cli.js`
+
+- Do **not** introduce runtime dependencies. Use only Node.js built-in
+  modules.
+- Do **not** change the command interface (flags, subcommands) without updating
+  `README.md`.
+- Keep the TUI key bindings consistent with the table in `README.md`.
+- Keep the published binary name `penote` unless an explicit rename is requested.
+- Test every modified command manually before committing:
+
+```bash
+bun library/cli.js list
+bun library/cli.js search <keyword>
+bun library/cli.js open --tui
+```
+
+---
+
+## Working with the Web UI (`library/index.html`)
+
+- Single-file, vanilla HTML/CSS/JS. Do **not** split into separate files.
+- Do **not** add external CDN dependencies.
+- Category filtering and instant search must remain functional after any change.
+- Test in a browser by starting the HTTP server:
+
+```bash
+bun library/cli.js open --editor
+```
+
+---
+
+## Working with brand assets (`assets/`)
+
+- The **SVG is the source of truth**; the PNG next to it is a render. Never edit
+  a PNG by hand — change the SVG and re-render:
+
+```bash
+rsvg-convert -w 1280 -h 640 assets/social-preview.svg -o assets/social-preview.png
+rsvg-convert -w 1000 -h 620 assets/demo.svg  -o assets/demo.png
+```
+
+- `social-preview.png` is the GitHub link preview. GitHub has no API for it, so
+  it is uploaded by hand under **Settings > General > Social preview**.
+- Terminal text inside `demo.svg` and `social-preview.svg` must match what
+  `library/cli.js` actually prints — re-run the command before changing a line.
+- Keep the indigo palette and the rounded-tile mark consistent across all three
+  files and the Web UI favicon in `library/index.html`.
+- SVG comments must not contain `--` (it is an XML parse error); write CLI flags
+  in prose instead.
+
+---
+
+## What Agents Should NOT Do
+
+- Do **not** rename existing category folders (`Java-Notes`, `Python-Notes`,
+  etc.) — the CLI resolves categories from folder names.
+- Do **not** add a dependency lockfile or package-manager toolchain for the
+  notes CLI. The existing root `package.json` is publish metadata only; keep
+  the CLI zero-dependency.
+- Do **not** modify `LICENSE` unless the copyright holder asks.
+- Do **not** add auto-generated files or compiled output to the repo.
+- Do **not** edit `CONTRIBUTING.md`, `SECURITY.md`, or `CODE_OF_CONDUCT.md`
+  unless explicitly asked (or the change is part of an approved repo-surface
+  update).
+- Do **not** create notes outside the established category folders without
+  confirming with the user.
+
+---
+
+## Commit Message Convention
+
+Follow [Conventional Commits](https://www.conventionalcommits.org):
+
+```
+<type>(<optional-scope>): <short description>
+```
+
+| Types | `feat` \| `fix` \| `docs` \| `refactor` \| `chore` \| `remove` |
+| Scopes | `notes` \| `java` \| `javascript` \| `python` \| `sql` \| `mongodb` \| `cli` \| `web-ui` \| `docs` \| `ci` |
+
+**Examples:**
+
+```
+feat(python): add advanced decorators note
+fix(cli): search flag not filtering by category
+docs: add new CLI command to README
+chore(ci): smoke-test list and search on Node 22
+```
+
+---
+
+## Quick Checklist Before Committing
+
+- [ ] Note file follows the naming convention (`lowercase_with_underscores.md`)
+- [ ] Note is placed in the correct category folder
+- [ ] Code blocks have language identifiers
+- [ ] CLI still runs without errors (`bun library/cli.js list`)
+- [ ] Commit message follows Conventional Commits
+- [ ] `README.md` updated if CLI commands or project structure changed
+- [ ] `CHANGELOG.md` updated under `Unreleased` for user-visible changes

package/CHANGELOG.md

@@ -0,0 +1,64 @@
+# Changelog
+
+All notable changes to penote are recorded here. The format follows
+[Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and the project
+follows [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [3.0.1] - 2026-09-02
+
+### Fixed
+
+- Republished `@burakboduroglu/penote` so the npm packument is complete and
+  `npm install @burakboduroglu/penote` / `npm view` resolve correctly. The
+  earlier `3.0.0` tarball existed without a usable package root document.
+
+## [3.0.0] - 2026-09-02
+
+### Added
+
+- Brand assets in the same visual language as the other repositories:
+  `assets/social-preview.svg` / `.png` (GitHub link preview, 1280x640) and
+  `assets/demo.svg` / `.png` (README terminal card). The SVG is the source; the
+  PNG is rendered from it.
+- CI smoke job that runs the documented `bun` development commands on Ubuntu and
+  macOS, alongside the existing Node matrix.
+
+### Changed
+
+- Product renamed to **penote**. npm package is now
+  [`@burakboduroglu/penote`](https://www.npmjs.com/package/@burakboduroglu/penote);
+  CLI binary is `penote`. The previous unscoped name `devnotetr` / `devnote` is
+  retired. The GitHub repository was renamed `dev-notes` -> `penote`; GitHub
+  redirects the old URLs.
+- Repository surface aligned with the rest of the open-source set: English
+  README positioned as agentic learning docs, `CHANGELOG.md`, `SECURITY.md`,
+  `CODE_OF_CONDUCT.md`, Conventional Commits in `CONTRIBUTING.md`, YAML issue
+  forms, pull request template, and a CI smoke workflow.
+- License file renamed from `LICENSE.md` to `LICENSE`.
+- App icon redesigned as a lowercase `pn` monogram with an AI sparkle on a
+  rounded indigo tile (`assets/penote-logo.svg`); the Web UI favicon and the
+  social preview card use the same mark.
+- `bun` is the package manager and local runner throughout: install
+  (`bun add -g`), scripts (`bun run start` / `bun run dev`) and every documented
+  development command (`bun library/cli.js …`). The published binary still
+  targets Node.js 18+ built-ins, and CI keeps the Node 18/20/22 matrix.
+- The npm tarball ships only `assets/penote-logo.svg` and `assets/demo.png`; the
+  social preview card is repository-only, halving the package to ~130 kB.
+
+### Removed
+
+- Tracked `.vscode/` settings (editor-local; ignored going forward).
+
+## [2.1.0] - 2026-05-04
+
+### Added
+
+- Packaged CLI and notes as the `devnotetr` npm package (`devnote` binary)
+  — superseded by `@burakboduroglu/penote` / `penote`.
+- Category folders for Java, JavaScript, Python, SQL, and MongoDB notes.
+- Zero-dependency CLI with list, search, open (editor / TUI / browser).
+- Single-file Web UI with category filter and instant search.
+
+[3.0.1]: https://github.com/burakboduroglu/penote/compare/v3.0.0...v3.0.1
+[3.0.0]: https://github.com/burakboduroglu/penote/compare/v2.1.0...v3.0.0
+[2.1.0]: https://github.com/burakboduroglu/penote/releases/tag/v2.1.0

package/CONTRIBUTING.md

@@ -0,0 +1,102 @@
+# Contributing to penote
+
+Thanks for looking. This repository is **agentic learning docs**: Turkish
+Markdown notes organised by topic, plus a zero-dependency Node.js CLI and a
+single-file Web UI so humans and coding agents can find and open the same
+material.
+
+Useful contributions are usually small — a clearer note, a missing example, a
+CLI edge case, or a Web UI fix. Before building anything substantial, open an
+issue and check the direction is wanted.
+
+**Out of scope for drive-by PRs:** renaming category folders, adding a package
+manager / build toolchain for the notes CLI, splitting the Web UI into multiple
+files, or turning the project into a general CMS.
+
+Please read the [Code of Conduct](CODE_OF_CONDUCT.md) before participating.
+
+## Getting started
+
+**Requirements:** [bun](https://bun.sh) for development, Node.js ≥ 18 for the
+published binary. No `bun install` is required — the CLI has no dependencies.
+
+```bash
+git clone https://github.com/burakboduroglu/penote.git
+cd penote
+bun library/cli.js list
+bun library/cli.js search hibernate
+bun library/cli.js open --editor
+```
+
+| Command | What it does |
+| ------- | ------------ |
+| `bun library/cli.js list` | Discover every note |
+| `bun library/cli.js search <kw>` | Full-library search |
+| `bun library/cli.js open --tui` | Interactive TUI |
+| `bun library/cli.js open --editor` | Local Web UI |
+| `bun run start` | Same as `bun library/cli.js` |
+| `bun run dev` | Open the Web UI |
+
+CI runs list/search smoke checks on Node 18, 20, and 22.
+
+## Where things live
+
+```
+*-Notes/              Topic Markdown (Turkish explanations)
+library/cli.js        CLI / TUI — Node built-ins only
+library/index.html    Web UI — single file, no CDN
+assets/               Logo and static assets
+AGENTS.md             Rules for coding agents editing this repo
+```
+
+## Adding or editing notes
+
+- Place the file in the correct `*-Notes/` folder.
+- Name it `lowercase_with_underscores.md`; use `_1`, `_2` for multi-part series.
+- Follow the note template in [AGENTS.md](AGENTS.md): Turkish prose, fenced
+  code blocks with a language tag, no YAML frontmatter, no external images.
+- Do not rename existing category folders — the CLI derives categories from them.
+
+## Commits
+
+Commit messages follow [Conventional Commits](https://www.conventionalcommits.org):
+
+```
+feat(notes): add spring transaction boundaries note
+fix(cli): search flag not filtering by category
+docs: clarify TUI key bindings in README
+chore(ci): run smoke checks on Node 22
+```
+
+| Type | Use for |
+| ---- | ------- |
+| `feat` | New note, CLI capability, or Web UI behaviour |
+| `fix` | Incorrect behaviour or broken content |
+| `docs` | README, contributing, comments that do not change behaviour |
+| `refactor` | Internal cleanup with no user-visible change |
+| `chore` | CI, tooling, release prep |
+
+Optional scopes: `notes`, `java`, `javascript`, `python`, `sql`, `mongodb`,
+`cli`, `web-ui`, `docs`, `ci`.
+
+Use the imperative mood, keep the subject under ~72 characters, and put the
+reasoning in the body when the change is not self-evident. No emoji.
+
+## Pull requests
+
+Branch from `main`, keep the change focused, and fill in the template. Say what
+changed, why, and how you verified it.
+
+- Update `README.md` when CLI flags, TUI keys, or project layout change.
+- Add a `CHANGELOG.md` entry under `Unreleased` for anything a user would notice.
+- Keep the CLI zero-dependency and the Web UI a single file unless the change
+  is explicitly about that architecture.
+
+Do not commit secrets, tokens, or machine-specific paths.
+
+## Reporting
+
+- **Bugs and ideas:** [the issue tracker](https://github.com/burakboduroglu/penote/issues)
+- **Vulnerabilities:** privately, per [SECURITY.md](SECURITY.md) — never as a public issue
+
+Thank you for contributing.

package/Java-Notes/jpa_hibernate.md

@@ -0,0 +1,168 @@
+## 📃 JPA Hibernate Annotations
+
+#### @Entity :
+
+- This annotation is used to mark a class as an entity class.
+- This annotation is used to create a table in the database.
+
+```Java
+@Entity
+public class Brand {
+}
+```
+
+---
+
+#### @Table :
+
+- @Table annotation is used to specify the details of the table that will be created in the database.
+- The name attribute of the @Table annotation is used to specify the name of the table.
+
+```Java
+@Entity
+@Table(name = "brands")
+public class Brand {
+}
+```
+
+---
+
+#### @Column :
+
+- @Column annotation is used to specify the details of the column that will be created in the database.
+- The name attribute of the @Column annotation is used to specify the name of the column.
+
+```Java
+
+
+@Entity
+@Table(name = "brands")
+public class Brand {
+
+    @Column(name = "brandName")
+    private String brandName;
+}
+```
+
+---
+
+#### @Id :
+
+- @Id annotation is used to specify the primary key of an entity.
+- The @Id annotation is always used with the @GeneratedValue annotation.
+
+```Java
+@Entity
+@Table(name = "brands")
+public class Brand {
+    @Id
+    @Column(name = "id")
+    private int id;
+
+}
+```
+
+---
+
+#### @ManyToOne :
+
+- @ManyToOne annotation is used to specify many to one relationship with another entity.
+
+```Java
+@Entity
+@Table(name = "brands")
+public class Brand {
+    @ManyToOne
+    @JoinColumn(name = "brandsDetails")
+    private BrandDetail brandDetail;
+}
+```
+
+---
+
+#### @OneToMany :
+
+- @OneToMany annotation is used to specify one to many relationship with another entity.
+- The mappedBy attribute of the @OneToMany annotation is used to specify the property of the entity that is the owner of the relationship.
+
+```Java
+@Entity
+@Table(name = "brands")
+public class Brand {
+
+    @OneToMany(mappedBy = "brands", fetch = FetchType.EAGER)
+    private BrandDetail brandDetail;
+}
+```
+
+---
+
+#### @PrimaryKeyJoinColumn :
+
+- @PrimaryKeyJoinColumn annotation is used to specify the primary key of the entity that is the owner of the relationship.
+
+```Java
+@Entity
+@Table(name = "brands")
+public class Brand {
+
+    @PrimaryKeyJoinColumn
+    private int id;
+}
+```
+
+---
+
+#### @JoinColumn :
+
+- @JoinColumn annotation is used to specify the column that will be created in the database as a foreign key.
+
+```Java
+@Entity
+@Table(name = "brands")
+public class Brand {
+
+    @JoinColumn(name = "brandDetail")
+    private BrandDetail brandDetail;
+}
+```
+
+---
+
+#### @JoinTable ve @MapsId:
+
+- It is used to specify the join table that will be created in the database.
+- @JoinTable annotation is used to specify the join table that will be created in the database.
+- @MapsId annotation is used to specify the primary key of the entity that is the owner of the relationship.
+
+```Java
+@Entity
+@Table(name = "brands")
+public class Brand {
+
+    @JoinTable(name = "brands")
+    private BrandDetail brandDetail;
+}
+```
+
+---
+
+#### @OneToOne:
+
+- @OneToOne annotation is used to specify one to one relationship with another entity.
+- The mappedBy attribute of the @OneToOne annotation is used to specify the property of the entity that is the owner of the relationship.
+
+```Java
+@Entity
+@Table(name = "brands")
+public class Brand {
+
+    @OneToOne(mappedBy = "brands")
+    private BrandDetail brandDetail;
+}
+```
+
+---
+
+✅ If you like this article, you can give me a star on. 😎
+Thanks for reading. 🙏

package/Java-Notes/lombok.md

@@ -0,0 +1,41 @@
+## 🥳 Lombok Annotations
+
+#### @Data:
+
+<ul>
+<li>@ToString</li>  
+<li>@EqualsAndHashCode</li>
+<li>@Getter</li>
+<li>@Setter</li>
+<li>@RequiredArgsConstructor</li>
+</ul>
+ This annotation is a convenient shortcut that bundles the features of @ToString, @EqualsAndHashCode, @Getter / @Setter and @RequiredArgsConstructor together.
+
+---
+
+#### @NoArgsConstructor:
+
+- It helps to create a constructor with no arguments.
+
+---
+
+#### @AllArgsConstructor:
+
+- It helps to create a constructor with all arguments.
+
+---
+
+#### @Getter:
+
+- Add every getter method for every field in the class.
+
+---
+
+#### @Setter:
+
+- Add every setter method for every field in the class.
+
+---
+
+✅ If you like this article, you can give me a star on. 😎
+Thanks for reading. 🙏

package/Java-Notes/readme.md

@@ -0,0 +1,15 @@
+### About Java-Notes 🚀
+
+Kişisel Java notları — Markdown formatında düzenlenmiştir.
+
+### Table of Contents 📚
+
+| File Name | Topics |
+| --------- | ------ |
+| [jpa_hibernate.md](jpa_hibernate.md) | Hibernate annotations & examples |
+| [lombok.md](lombok.md) | Lombok annotations & examples |
+| [spring_boot_framework.md](spring_boot_framework.md) | Spring Boot annotations & examples |
+
+---
+
+[← README](../README.md)