https://github.com/sphericalkat/potatosync
A simple API for backup and restore of the PotatoNotes app, written in Go
https://github.com/sphericalkat/potatosync
Last synced: about 1 year ago
JSON representation
A simple API for backup and restore of the PotatoNotes app, written in Go
- Host: GitHub
- URL: https://github.com/sphericalkat/potatosync
- Owner: SphericalKat
- License: gpl-3.0
- Created: 2019-10-27T17:35:38.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-12-15T02:45:59.000Z (over 2 years ago)
- Last Synced: 2025-04-05T01:22:29.710Z (about 1 year ago)
- Language: Go
- Homepage: https://atechnohazard.github.io/potatosync
- Size: 713 KB
- Stars: 14
- Watchers: 2
- Forks: 5
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Potatosync
This 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.
[](https://github.com/ATechnoHazard/potatosync/actions) 
## Building
The 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.
To build the project, you must first have the following dependencies -
* `make`
* `Go version 1.11 and onwards`
* `docker`
To install all package dependencies, run `make dep`.
To build the binary, run `make build`
To build the docker image with the binary, run `make img-build`
*Note: You MUST have built the binary to be able to build the docker image.*
## Self-Hosting
In order to host the api yourself you need to follow these steps:
* Install Docker https://docs.docker.com/install/
* Install Docker-Compose https://docs.docker.com/compose/install/
* Download the docker-compose.yml
```
wget https://raw.githubusercontent.com/ATechnoHazard/potatosync/master/docker-compose.yml
```
* Download the .env file
```
wget https://raw.githubusercontent.com/ATechnoHazard/potatosync/master/docker.env
```
* Run docker-compose in the directory where you downloaded the file
```
sudo docker-compose up
```
* You should now be up and running!
## Contributing
We 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.
## Links
