mirror of
https://github.com/m1k1o/neko.git
synced 2025-07-23 19:49:02 +02:00
update developer guide.
This commit is contained in:
parent
bfb917bbea
commit
b6742c92ce
10 changed files with 78 additions and 121 deletions
|
@ -1,14 +1,10 @@
|
|||
---
|
||||
sidebar_position: 2
|
||||
---
|
||||
# Developer Guide
|
||||
|
||||
# Building from Source
|
||||
:::info
|
||||
This guide is Work in Progress. It is not complete and will be updated over time.
|
||||
:::
|
||||
|
||||
This guide walks you through the process of setting up Neko on your local machine or server.
|
||||
|
||||
## Prerequisites {#prerequisites}
|
||||
|
||||
Before proceeding, ensure that you have the following installed on your system:
|
||||
## Dependencies
|
||||
|
||||
- [node.js](https://nodejs.org/) and [npm](https://www.npmjs.com/) (for building the frontend).
|
||||
- [go](https://golang.org/) (for building the server).
|
||||
|
@ -32,38 +28,9 @@ Before proceeding, ensure that you have the following installed on your system:
|
|||
sudo apt-get install xdotool xclip libgtk-3-0 libgtk-3-dev libopus0 libvpx6;
|
||||
```
|
||||
|
||||
## Step 1: Clone the Repository {#step-1}
|
||||
## Next Steps
|
||||
|
||||
Start by cloning the Neko Git repository to your machine:
|
||||
import DocCardList from '@theme/DocCardList';
|
||||
import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
|
||||
|
||||
```bash
|
||||
git clone https://github.com/m1k1o/neko.git
|
||||
cd neko
|
||||
```
|
||||
|
||||
## Step 2: Build the Frontend {#step-2}
|
||||
|
||||
Navigate to the `client` directory and install the dependencies:
|
||||
|
||||
```shell
|
||||
cd client;
|
||||
npm install;
|
||||
npm run build;
|
||||
```
|
||||
|
||||
## Step 3: Build the Server {#step-3}
|
||||
|
||||
Navigate to the `server` directory and build the server:
|
||||
|
||||
```shell
|
||||
cd server;
|
||||
go build;
|
||||
```
|
||||
|
||||
## Step 4: Run the Server {#step-4}
|
||||
|
||||
Finally, run the server:
|
||||
|
||||
```shell
|
||||
./server/server;
|
||||
```
|
||||
<DocCardList items={useCurrentSidebarCategory().items}/>
|
|
@ -1,7 +0,0 @@
|
|||
---
|
||||
sidebar_position: 4
|
||||
---
|
||||
|
||||
# API Reference
|
||||
|
||||
Documentation of available APIs for integrating with Neko (WebSocket, REST, etc.).
|
46
webpage/docs/developer-guide/build.md
Normal file
46
webpage/docs/developer-guide/build.md
Normal file
|
@ -0,0 +1,46 @@
|
|||
---
|
||||
description: Building Neko from source
|
||||
---
|
||||
|
||||
# Building From Source
|
||||
|
||||
This guide walks you through the process of setting up Neko on your local machine or server.
|
||||
|
||||
Start by cloning the Neko Git repository to your machine:
|
||||
|
||||
```bash
|
||||
git clone https://github.com/m1k1o/neko.git
|
||||
cd neko
|
||||
```
|
||||
|
||||
## Building the Frontend {#frontend}
|
||||
|
||||
Prerequisites for building the frontend:
|
||||
- [node.js](https://nodejs.org/) and [npm](https://www.npmjs.com/)
|
||||
|
||||
Navigate to the `client` directory and install the dependencies:
|
||||
|
||||
```bash
|
||||
cd client;
|
||||
npm install;
|
||||
npm run build;
|
||||
```
|
||||
|
||||
The `npm run build` command will create a production build of the frontend in the `client/build` directory.
|
||||
|
||||
## Building the Server {#server}
|
||||
|
||||
Prerequisites for building the server:
|
||||
- [go](https://golang.org/) (version 1.18 or higher)
|
||||
- Dependencies for building the server:
|
||||
```bash
|
||||
sudo apt-get install -y --no-install-recommends libx11-dev libxrandr-dev libxtst-dev libgtk-3-dev libxcvt-dev libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev
|
||||
```
|
||||
Navigate to the `server` directory and build the server:
|
||||
|
||||
```bash
|
||||
cd server;
|
||||
./build;
|
||||
```
|
||||
|
||||
This will create a binary file named `neko` in the `bin` directory along with `plugins` that were built with the server.
|
|
@ -1,7 +0,0 @@
|
|||
---
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
# Code Structure
|
||||
|
||||
Explanation of the project’s architecture and key components.
|
|
@ -1,7 +0,0 @@
|
|||
---
|
||||
sidebar_position: 6
|
||||
---
|
||||
|
||||
# Contributing Guide
|
||||
|
||||
How to contribute to the project, submit patches, and report issues.
|
|
@ -1,7 +0,0 @@
|
|||
---
|
||||
sidebar_position: 3
|
||||
---
|
||||
|
||||
# Running in Development Mode
|
||||
|
||||
Setting up a development environment for contributing.
|
|
@ -1,7 +0,0 @@
|
|||
---
|
||||
sidebar_position: 7
|
||||
---
|
||||
|
||||
# Style Guide
|
||||
|
||||
Code formatting, linting, and other development conventions.
|
|
@ -1,7 +0,0 @@
|
|||
---
|
||||
sidebar_position: 5
|
||||
---
|
||||
|
||||
# Testing & Debugging
|
||||
|
||||
Debugging tools, test cases, and best practices for troubleshooting.
|
Loading…
Add table
Add a link
Reference in a new issue