{"id":27121207,"url":"https://github.com/gopad/gopad-api","last_synced_at":"2025-04-07T10:52:06.056Z","repository":{"id":37484070,"uuid":"116067113","full_name":"gopad/gopad-api","owner":"gopad","description":"Gopad: API","archived":false,"fork":false,"pushed_at":"2024-05-22T22:14:38.000Z","size":895,"stargazers_count":2,"open_issues_count":2,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-05-23T01:05:44.022Z","etag":null,"topics":["api","etherpad","go","golang","gopad","server"],"latest_commit_sha":null,"homepage":"https://gopad.eu","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/gopad.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","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":"2018-01-02T23:14:36.000Z","updated_at":"2024-05-29T01:56:11.423Z","dependencies_parsed_at":"2023-10-25T22:35:16.381Z","dependency_job_id":"0d76c5b6-fda9-4cf7-a0fc-773c3943e4b0","html_url":"https://github.com/gopad/gopad-api","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gopad%2Fgopad-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gopad%2Fgopad-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gopad%2Fgopad-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gopad%2Fgopad-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gopad","download_url":"https://codeload.github.com/gopad/gopad-api/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247640517,"owners_count":20971555,"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","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":["api","etherpad","go","golang","gopad","server"],"created_at":"2025-04-07T10:52:05.381Z","updated_at":"2025-04-07T10:52:06.049Z","avatar_url":"https://github.com/gopad.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Gopad: API server\n\n[![General Workflow](https://github.com/gopad/gopad-api/actions/workflows/general.yml/badge.svg)](https://github.com/gopad/gopad-api/actions/workflows/general.yml) [![Join the Matrix chat at https://matrix.to/#/#gopad:matrix.org](https://img.shields.io/badge/matrix-%23gopad-7bc9a4.svg)](https://matrix.to/#/#gopad:matrix.org) [![Codacy Badge](https://app.codacy.com/project/badge/Grade/7143ea13bd644aa3be6749ca967be7d0)](https://app.codacy.com/gh/gopad/gopad-api/dashboard?utm_source=gh\u0026utm_medium=referral\u0026utm_content=\u0026utm_campaign=Badge_grade) [![Go Reference](https://pkg.go.dev/badge/github.com/gopad/gopad-api.svg)](https://pkg.go.dev/github.com/gopad/gopad-api) [![GitHub Repo](https://img.shields.io/badge/github-repo-yellowgreen)](https://github.com/gopad/gopad-api)\n\n\u003e [!CAUTION]\n\u003e This project is in active development and does not provide any stable release\n\u003e yet, you can expect breaking changes until our first real release!\n\nGopoad will be a simple web interface to write and update markdown-based\ndocuments. You can compare it with an Etherpad, just focused on markdown writing\nand formatting. I thought it's time to implement a shiny application with Go for\nthe API and with VueJS for the UI.\n\n## Install\n\nYou can download prebuilt binaries from the [GitHub releases][releases] or from\nour [download site][downloads]. Besides that we also prepared repositories for\nDEB and RPM packages which can be found at [Baltorepo][baltorepo]. If you prefer\nto use containers you could use our images published on [GHCR][ghcr],\n[Docker Hub][dockerhub] or [Quay][quay]. You are a Mac user? Just take a look\nat our [homebrew formula][homebrew]. If you need further guidance how to\ninstall this take a look at our [documentation][docs].\n\n## Build\n\nIf you are not familiar with [Nix][nix] it is up to you to have a working\nenvironment for Go (\u003e= 1.24.0) and Nodejs (22.x) as the setup won't we covered\nwithin this guide. Please follow the official install instructions for\n[Go][golang] and [Nodejs][nodejs]. Beside that we are using [go-task][gotask] to\ndefine all commands to build this project.\n\n```console\ngit clone https://github.com/gopad/gopad-api.git\ncd gopad-api\n\ntask fe:install fe:build be:build\n./bin/gopad-api -h\n```\n\nIf you got [Nix][nix] and [Direnv][direnv] configured you can simply execute\nthe following commands to get al dependencies including [go-task][gotask] and\nthe required runtimes installed. You are also able to directly use the process\nmanager of [devenv][devenv]:\n\n```console\ncat \u003c\u003c EOF \u003e .envrc\nuse flake . --impure --extra-experimental-features nix-command\nEOF\n\ndirenv allow\n```\n\nWe are embedding all the static assets into the binary so there is no need for\nany webserver or anything else beside launching this binary.\n\n## Development\n\nTo start developing on this project you have to execute only a few commands. To\nstart development just execute those commands in different terminals:\n\n```console\ntask watch:server\ntask watch:frontend\n```\n\nThe development server of the backend should be running on\n[http://localhost:8080](http://localhost:8080) while the frontend should be\nrunning on [http://localhost:5173](http://localhost:5173). Generally it supports\nhot reloading which means the services are automatically restarted/reloaded on\ncode changes.\n\nIf you got [Nix][nix] configured you can simply execute the [devenv][devenv]\ncommand to start the frontend, backend, MariaDB, PostgreSQL and Minio:\n\n```console\ndevenv up\n```\n\n## Security\n\nIf you find a security issue please contact\n[gopad@webhippie.de](mailto:gopad@webhippie.de) first.\n\n## Contributing\n\nFork -\u003e Patch -\u003e Push -\u003e Pull Request\n\n## Authors\n\n-   [Thomas Boerger](https://github.com/tboerger)\n\n## License\n\nApache-2.0\n\n## Copyright\n\n```console\nCopyright (c) 2018 Thomas Boerger \u003cthomas@webhippie.de\u003e\n```\n\n[releases]: https://github.com/gopad/gopad-api/releases\n[downloads]: https://dl.gopad.eu\n[baltorepo]: https://gopad.baltorepo.com/stable/\n[homebrew]: https://github.com/gopad/homebrew-gopad\n[ghcr]: https://github.com/orgs/gopad/packages\n[dockerhub]: https://hub.docker.com/r/gopad/gopad-api/tags/\n[quay]: https://quay.io/repository/gopad/gopad-api?tab=tags\n[docs]: https://gopad.eu/\n[nix]: https://nixos.org/\n[golang]: http://golang.org/doc/install.html\n[gotask]: https://taskfile.dev/installation/\n[direnv]: https://direnv.net/\n[devenv]: https://devenv.sh/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgopad%2Fgopad-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgopad%2Fgopad-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgopad%2Fgopad-api/lists"}