README
¶
Gopad: API server
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.23.1, 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 gopad@webhippie.de first.
Contributing
Fork -> Patch -> Push -> Pull Request
Authors
License
Apache-2.0
Copyright
Copyright (c) 2018 Thomas Boerger <thomas@webhippie.de>
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
pkg
|
|
|
api/v1
Package v1 provides primitives to interact with the openapi HTTP API.
|
Package v1 provides primitives to interact with the openapi HTTP API. |
|
service/teams
Package teams is a generated GoMock package.
|
Package teams is a generated GoMock package. |
|
service/user_teams
Package userteams is a generated GoMock package.
|
Package userteams is a generated GoMock package. |
|
service/users
Package users is a generated GoMock package.
|
Package users is a generated GoMock package. |
|
store
Package store is a generated GoMock package.
|
Package store is a generated GoMock package. |
|
upload
Package upload is a generated GoMock package.
|
Package upload is a generated GoMock package. |