README
¶
Gopad: API server
[!CAUTION] This project is in active development and does not provide any stable release yet, you can expect breaking changes until our first real release!
Gopoad will be a simple web interface to write and update markdown-based documents. You can compare it with an Etherpad, just focused on markdown writing and formatting. I thought it's time to implement a shiny application with Go for the API and with VueJS for the UI.
Install
You can download prebuilt binaries from the GitHub releases or from our download site. If you prefer to use containers you could use our images published on Docker Hub or Quay. You are a Mac user? Just take a look at our homebrew formula. If you need further guidance how to install this take a look at our documentation.
Development
Make sure you have a working Go environment, for further reference or a guide take a look at the install instructions. This project requires Go >= v1.24, at least that's the version we are using.
git clone https://github.com/gopad/gopad-api.git
cd gopad-api
make generate build
./bin/gopad-api -h
Security
If you find a security issue please contact [email protected] first.
Contributing
Fork -> Patch -> Push -> Pull Request
Authors
License
Apache-2.0
Copyright
Copyright (c) 2018 Thomas Boerger <[email protected]>
Directories