Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions .github/workflows/release-publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -230,7 +230,7 @@ jobs:
type=raw,value=latest,enable=${{ !contains(needs.check.outputs.version, '-') }}
labels: |
org.opencontainers.image.title=WordyMe
org.opencontainers.image.description=Centralized platform for students to manage educational information
org.opencontainers.image.description=Your own private wiki. Self-hosted notes and documentation, light enough to run on a Raspberry Pi.
org.opencontainers.image.vendor=TeamCoderz Ltd
org.opencontainers.image.url=https://teamcoderz.org
org.opencontainers.image.licenses=AGPL-3.0-or-later
Expand Down Expand Up @@ -351,7 +351,7 @@ jobs:
type=raw,value=latest,enable=${{ !contains(needs.check.outputs.version, '-') }}
labels: |
org.opencontainers.image.title=WordyMe
org.opencontainers.image.description=Centralized platform for students to manage educational information
org.opencontainers.image.description=Your own private wiki. Self-hosted notes and documentation, light enough to run on a Raspberry Pi.
org.opencontainers.image.vendor=TeamCoderz Ltd
org.opencontainers.image.url=https://teamcoderz.org
org.opencontainers.image.licenses=AGPL-3.0-or-later
Expand Down Expand Up @@ -436,7 +436,7 @@ jobs:
type=raw,value=latest,enable=${{ !contains(needs.check.outputs.version, '-') }}
labels: |
org.opencontainers.image.title=WordyMe
org.opencontainers.image.description=Centralized platform for students to manage educational information
org.opencontainers.image.description=Your own private wiki. Self-hosted notes and documentation, light enough to run on a Raspberry Pi.
org.opencontainers.image.vendor=TeamCoderz Ltd
org.opencontainers.image.url=https://teamcoderz.org
org.opencontainers.image.licenses=AGPL-3.0-or-later
Expand Down Expand Up @@ -492,7 +492,7 @@ jobs:
# A literal rather than the repository description, which is optional
# on GitHub and would blank the listing if it were ever unset.
# Docker Hub caps this at 100 characters.
short-description: 'Self-hosted note-taking and document management for students. AGPL-3.0.'
short-description: 'Self-hosted personal wiki and note-taking app. AGPL-3.0.'
# A dedicated short page, not DOCKER.md: Docker Hub truncates
# listings at 25,000 bytes and DOCKER.md is well past that.
readme-filepath: ./DOCKERHUB.md
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/verify-publishing.yml
Original file line number Diff line number Diff line change
Expand Up @@ -352,7 +352,7 @@ jobs:
username: ${{ secrets.DOCKERHUB_USERNAME }}
password: ${{ secrets.DOCKERHUB_TOKEN }}
repository: ${{ env.DOCKERHUB_IMAGE }}
short-description: 'Self-hosted note-taking and document management for students. AGPL-3.0.'
short-description: 'Self-hosted personal wiki and note-taking app. AGPL-3.0.'
# A dedicated short page, not DOCKER.md: Docker Hub truncates
# listings at 25,000 bytes and DOCKER.md is well past that. This step
# stays fatal here on purpose — the release workflow marks it
Expand Down
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ We're thrilled to have you here. Whether you're a first-time contributor or an e
- **Learn and grow** — Work with modern technologies like React 19, TypeScript, and Turborepo
- **Build your portfolio** — Meaningful open source contributions that showcase your skills
- **Join a community** — Connect with developers who share your passion
- **Make an impact** — Help students worldwide manage their educational information better
- **Make an impact** — Help people own their notes and documentation instead of renting them

> **Before you start:** Please search [existing issues](https://github.com/TeamCoderz/WordyMe/issues) and [pull requests](https://github.com/TeamCoderz/WordyMe/pulls) to see if someone else is working on something similar.

Expand Down Expand Up @@ -92,7 +92,7 @@ pnpm license:check # check tracked and untracked applicable files (full-repo

## Commercial Features

WordyMe™ follows an Open Core model. If you are interested in developing features intended for large institutions (e.g., SAML/SSO, advanced audit logging), please contact us first. These features often belong in our Enterprise version, and we can discuss how to best collaborate.
WordyMe™ follows an Open Core model. If you are interested in developing features intended for large organizations (e.g., SAML/SSO, advanced audit logging), please contact us first. These features often belong in our Enterprise version, and we can discuss how to best collaborate.

---

Expand Down
4 changes: 2 additions & 2 deletions DOCKERHUB.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# WordyMe

**A lightweight note-taking app you can self-host anywhere. Even on your Raspberry Pi.**
**A lightweight personal wiki you can self-host anywhere. Even on your Raspberry Pi.**

WordyMe is a centralized platform for students to manage educational information: rich documents with diagram (Mermaid), math (KaTeX) and music-notation support, organized into spaces, with revision history, favorites and real-time updates.
WordyMe is a self-hosted personal wiki and note-taking app: rich documents with diagram (Mermaid), math (KaTeX) and music-notation support, organized into spaces, with revision history, favorites and real-time updates.

- **One container, one port.** The web app and API are served from the same origin — no separate frontend, no reverse-proxy gymnastics required.
- **`linux/amd64` and `linux/arm64`** in every tag. Runs on a normal server, an Apple Silicon Mac, or a Raspberry Pi 4/5.
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@
<img src="https://img.shields.io/badge/PRs-Welcome-brightgreen" alt="PRs Welcome">
</p>

WordyMe™ is a centralized platform for students to manage educational information. It provides a rich note-taking experience with support for documents, spaces, and a powerful editor with diagram and math support.
WordyMe™ is a lightweight self-hosted personal wiki and note-taking app. Rich editor, one Docker container, runs anywhere — even a Raspberry Pi. Documents are organized into spaces, with diagram and math support, revision history and real-time updates.

🏛 Open Core & Mission
WordyMe™ is built and maintained by TeamCoderz Ltd with a mission to keep powerful educational tools accessible.
WordyMe™ is built and maintained by TeamCoderz Ltd with a mission to keep powerful, private tools in the hands of the people who use them.

The Core: This repository contains the open-source core of WordyMe™, licensed under AGPL-3.0.
The Enterprise: We will offer a PRO version for institutions requiring Service Documentation Management, permission control, advanced SSO, audit logs, managed compliance and more. All of this will be available in our Next Generation ERP Solution: [ReactSuite](https://www.linkedin.com/showcase/reactsuite)
The Enterprise: We will offer a PRO version for organizations requiring Service Documentation Management, permission control, advanced SSO, audit logs, managed compliance and more. All of this will be available in our next-generation ERP solution: [ReactSuite](https://www.linkedin.com/showcase/reactsuite)

🚀 Overview
WordyMe™ is a full-stack application built as a monorepo using Turborepo. It consists of a modern React web application and an Express.js backend API, along with shared packages for editor functionality, UI components, and type definitions.
Expand Down
2 changes: 1 addition & 1 deletion apps/web/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
<meta name="theme-color" content="#000000" />
<meta
name="description"
content="Centralized platform for students to manage educational information"
content="Your own private wiki. Self-hosted notes and documentation, light enough to run on a Raspberry Pi."
/>
<link rel="apple-touch-icon" href="/apple-touch-icon.png" />
<title>WordyMe</title>
Expand Down
3 changes: 2 additions & 1 deletion apps/web/vite.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,8 @@ export default defineConfig(({ mode }) => {
manifest: {
name: 'WordyMe',
short_name: 'WordyMe',
description: 'Centralized platform for students to manage educational information',
description:
'Your own private wiki. Self-hosted notes and documentation, light enough to run on a Raspberry Pi.',
theme_color: '#000000',
background_color: '#ffffff',
display: 'standalone',
Expand Down
Loading