Skip to content

Latest commit

 

History

History
55 lines (41 loc) · 2.05 KB

CONTRIBUTING.md

File metadata and controls

55 lines (41 loc) · 2.05 KB

Contributing

To build and start a development version of LatenSee locally, first install Go and npm, then run the following:

$ git clone https://github.com/loopholelabs/latensee.git --single-branch
$ cd latensee
$ go generate ./...
$ go run .

To start the backend and open the frontend in a browser instead of an application window during development, run the following:

# Start the backend in the first terminal
$ HYDRAPP_BACKEND_LADDR=localhost:1337 HYDRAPP_TYPE=dummy go run .
# Start the frontend in a second terminal
$ cd pkg/frontend
$ npm run dev
# Now open http://localhost:1234 in your browser

To build the DEB, RPM, Flatpak, MSI, EXE, DMG, APK, and static binaries for all other platforms, run the following:

$ hydrapp build
# You can find the built packages in the out/ directory

If you only want to build certain packages or for certain architectures, for example to only build the APKs, pass --exclude like in the following:

$ hydrapp build --exclude '(binaries|deb|rpm|flatpak|msi|dmg|docs|tests)'

For more information, see the hydrapp documentation.

LatenSee uses GitHub to manage reviews of pull requests.

  • If you have a trivial fix or improvement, go ahead and create a pull request, addressing (with @...) the maintainer of this repository (see MAINTAINERS.md) in the description of the pull request.

  • If you plan to do something more involved, first discuss your ideas on our Discord. This will avoid unnecessary work and surely give you and us a good deal of inspiration.

  • Relevant coding style guidelines are the Go Code Review Comments and the Formatting and style section of Peter Bourgon's Go: Best Practices for Production Environments.

  • Be sure to sign off on the DCO