Developer Guide
info
This guide is Work in Progress. It is not complete and will be updated over time.
Dependencies
- node.js and npm (for building the frontend).
- go (for building the server).
- gstreamer (for video processing).
sudo apt-get install libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev \gstreamer1.0-plugins-base gstreamer1.0-plugins-good \gstreamer1.0-plugins-bad gstreamer1.0-plugins-ugly \gstreamer1.0-pulseaudio;
- x.org (for X11 server).
sudo apt-get install libx11-dev libxrandr-dev libxtst-dev libxcvt-dev xorg;
- pulseaudio (for audio support).
sudo apt-get install pulseaudio;
- other dependencies:
sudo apt-get install xdotool xclip libgtk-3-0 libgtk-3-dev libopus0 libvpx6;
Next Steps
Repository Structure
Project structure of the neko repository.
Local Development
Running Neko locally for development
Building from Source
Building the Neko frontend and backend from source
API Reference
OpenAPI documentation for the Neko API