annote.app
Annotate articles with ease.
Tech Stack
- Frontend + backend: Nuxt
- Deployment: Coolify + Hetzner VPS
Quickstart
cd into app- Run
pnpm install then pnpm dev
- To debug, in vscode open the debugger tab and run the
nuxt debug configuration. This is defined in .vscode/launch.json.
Contributing
- Branch off the dev branch, in the format of
<issueType>/<issue-number>_description-of-task. For example, docs/3_update-readme. issueType belongs to any of feat:
- fix:
- chore:
- docs:
- refactor:
You can also combine them like feat & docs:.
- Make a PR and have at least 1 person approve it.
- Once approved, merge your own PR so the commit history shows the author of a PR merging it in.
Our Team