{"id":23658273,"url":"https://github.com/peruibeloko/typewriter","last_synced_at":"2025-09-01T11:31:09.624Z","repository":{"id":165306366,"uuid":"234405141","full_name":"peruibeloko/typewriter","owner":"peruibeloko","description":"Simple CMS for simple blogging","archived":false,"fork":false,"pushed_at":"2025-03-03T17:07:03.000Z","size":550,"stargazers_count":8,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-02T15:51:14.216Z","etag":null,"topics":["blogging","cms","deno","hono","restful","selfhosted"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/peruibeloko.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-01-16T20:25:19.000Z","updated_at":"2025-03-03T17:07:08.000Z","dependencies_parsed_at":null,"dependency_job_id":"e35a1d95-7809-4178-945f-ba171a50fbe3","html_url":"https://github.com/peruibeloko/typewriter","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/peruibeloko/typewriter","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/peruibeloko%2Ftypewriter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/peruibeloko%2Ftypewriter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/peruibeloko%2Ftypewriter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/peruibeloko%2Ftypewriter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/peruibeloko","download_url":"https://codeload.github.com/peruibeloko/typewriter/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/peruibeloko%2Ftypewriter/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273114746,"owners_count":25048253,"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","status":"online","status_checked_at":"2025-09-01T02:00:09.058Z","response_time":120,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["blogging","cms","deno","hono","restful","selfhosted"],"created_at":"2024-12-29T00:06:36.671Z","updated_at":"2025-09-01T11:31:09.619Z","avatar_url":"https://github.com/peruibeloko.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Typewriter\n\nSimple CMS written in TypeScript, runs on [Hono](https://hono.dev/) and [Deno](https://deno.com/). Data is stored using Markdown files on disk and SQLite for metadata.\n\n## Installation\n\n0. Install Deno\n1. `git clone`\n2. `deno install`\n3. [Configure typewriter](#configuration)\n4. `deno task start`\n\n## Configuration\n\nTypewriter uses two sources for its config: Either a **TOML file** or **environment variables**. The former takes precedence over the latter.\n\n### TOML file example (for self hosting)\n\n```toml\n# A signing secret for your JWT\nJWT_SECRET = \"some big random string for signing JWTs\"\n\n# [Optional] Contains either:\n# - A folder where a database file will be created for you\n# - A database file itself\nDB_PATH = \"/some/path/to/folder/or/typewriter.db\"\n\n# [Optional] Enables console verbosity. Also prints all registered routes\nVERBOSE = false\n```\n\n### Environment variables example (for cloud hosting)\n\n```bash\n# A signing secret for your JWT\nexport TYPEWRITER_JWT_SECRET=\"some big random string for signing JWTs\"\n\n# [Optional] Contains either:\n# - A folder where a database file will be created for you\n# - A database file itself\nexport TYPEWRITER_DB_PATH=\"/some/path/to/folder/or/typewriter.db\"\n\n# [Optional] Enables console verbosity. Also prints all registered routes\nexport TYPEWRITER_VERBOSE=false\n```\n\n## Authentication\n\nTypewriter's authentication model is a combination of an allowlist with OTPs.\n\nThere are three steps:\n\n1. Send a `register \u003cemail\u003e` command on the typewriter CLI to get your email on the allowlist\n\n```\n\u003e register test@example.com\nsuccessfully registered test@example.com\n```\n\n2. Send a `POST` request to `/auth/signup` to get an OTP secret\n\n```json\n{\n  \"displayName\": \"John Smith\",\n  \"email\": \"john@example.com\"\n}\n```\n\n3. Send a `POST` request to `/auth/login` to get your JWT\n\n```json\n{\n  \"email\": \"john@example.com\",\n  \"code\": \"123456\",\n}\n```\n\n## Usage\n\nTypewriter has its own web server, which answers to RESTful requests. The full API is outlined [here](https://carlinhos.dev.br/typewriter/swagger) (Not built yet)\n\nIt also provides a simple CLI for issuing administrative commands, such as registering a new user and gracefully shutting down the server.\n\n### Commands\n\n\u003e TODO\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fperuibeloko%2Ftypewriter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fperuibeloko%2Ftypewriter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fperuibeloko%2Ftypewriter/lists"}