{"id":19598273,"url":"https://github.com/sphericalkat/potatosync","last_synced_at":"2025-04-27T16:31:46.362Z","repository":{"id":38406362,"uuid":"217891655","full_name":"SphericalKat/potatosync","owner":"SphericalKat","description":"A simple API for backup and restore of the PotatoNotes app, written in Go","archived":false,"fork":false,"pushed_at":"2023-12-15T02:45:59.000Z","size":730,"stargazers_count":14,"open_issues_count":3,"forks_count":5,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-05T01:22:29.710Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://atechnohazard.github.io/potatosync","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/SphericalKat.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"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":"2019-10-27T17:35:38.000Z","updated_at":"2022-10-12T09:48:09.000Z","dependencies_parsed_at":"2024-06-20T05:55:49.711Z","dependency_job_id":"0fe607d1-4178-43a4-abe4-e3f350e421ef","html_url":"https://github.com/SphericalKat/potatosync","commit_stats":null,"previous_names":["atechnohazard/potatosync"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SphericalKat%2Fpotatosync","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SphericalKat%2Fpotatosync/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SphericalKat%2Fpotatosync/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SphericalKat%2Fpotatosync/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SphericalKat","download_url":"https://codeload.github.com/SphericalKat/potatosync/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251171266,"owners_count":21547083,"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":[],"created_at":"2024-11-11T09:05:37.525Z","updated_at":"2025-04-27T16:31:45.855Z","avatar_url":"https://github.com/SphericalKat.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Potatosync\nThis is a custom API for supporting the PotatoNotes app, which can be found [here](https://github.com/HrX03/PotatoNotes/) on GitHub, and can be downloaded from the play store. If you feel like contributing, feel free to send a PR our way.\n\n\n[![Actions Status](https://github.com/ATechnoHazard/potatosync/workflows/CI/badge.svg)](https://github.com/ATechnoHazard/potatosync/actions) ![](https://img.shields.io/docker/pulls/atechnohazard/potatosync)\n## Building\nThe project has a Makefile conveniently set up for building the project and its docker image. We use scratch containers and add only the binary, instead of building the binary inside the container. This is done to reduce image size.\n\nTo build the project, you must first have the following dependencies -\n* `make`\n* `Go version 1.11 and onwards`\n* `docker`\n\nTo install all package dependencies, run `make dep`.\n\nTo build the binary, run `make build`\n\nTo build the docker image with the binary, run `make img-build`\n\n*Note: You MUST have built the binary to be able to build the docker image.*\n\n## Self-Hosting\nIn order to host the api yourself you need to follow these steps:\n\n* Install Docker https://docs.docker.com/install/ \n* Install Docker-Compose https://docs.docker.com/compose/install/\n* Download the docker-compose.yml\n```\nwget https://raw.githubusercontent.com/ATechnoHazard/potatosync/master/docker-compose.yml\n```\n* Download the .env file\n```\nwget https://raw.githubusercontent.com/ATechnoHazard/potatosync/master/docker.env\n```\n* Run docker-compose in the directory where you downloaded the file\n```\nsudo docker-compose up\n```\n* You should now be up and running!\n\n## Contributing\nWe are grateful for any and all contributions, so feel free to send a PR our way! Just remember to `gofmt` often, and document as much as you can.\n\n## Links\n\u003ca href='https://play.google.com/store/apps/details?id=com.potatoproject.notes\u0026hl=en\u0026pcampaignid=pcampaignidMKT-Other-global-all-co-prtnr-py-PartBadge-Mar2515-1'\u003e\u003cimg alt='Get it on Google Play' src='https://play.google.com/intl/en_us/badges/static/images/badges/en_badge_web_generic.png'/\u003e\u003c/a\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsphericalkat%2Fpotatosync","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsphericalkat%2Fpotatosync","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsphericalkat%2Fpotatosync/lists"}