neko/webpage/docs/developer-guide/building-from-source.md

sidebar_position
2

Building from Source

This guide walks you through the process of setting up Neko on your local machine or server.

Prerequisites

Before proceeding, ensure that you have the following installed on your system:

• 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;
  

Step 1: Clone the Repository

Start by cloning the Neko Git repository to your machine:

git clone https://github.com/m1k1o/neko.git
cd neko

Step 2: Build the Frontend

Navigate to the client directory and install the dependencies:

cd client;
npm install;
npm run build;

Step 3: Build the Server

Navigate to the server directory and build the server:

cd server;
go build;

Step 4: Run the Server

Finally, run the server:

./server/server;