Contribution Guide

Installing Node.js and npm

To contribute to the Remnawave Reverse-proxy project, you need to have Node.js and npm installed on your system. You can download and install them from the Node.js official website.

Installing git

If you haven’t already, install git on your system. You can find installation instructions on the git official website and downloads page on git-scm.com.

Cloning the Repository

To get started, clone the Remnawave Reverse-proxy repository to your local machine.
Terminal window
```
git clone https://github.com/eGamesAPI/remnawave-reverse-proxy
```
Navigate to the project directory
Terminal window
```
cd remnawave-reverse-proxy/docs
```

Installing Dependencies

Before you can build the documentation, you need to install the necessary dependencies. Run the following command in the docs directory.
Terminal window
```
npm install
```
To build the documentation locally, run:
Terminal window
```
npm run dev
```

This will start a local development server, and you can view the documentation at http://localhost:4321.

✨ Starlight included Documentation

🚀 Project Structure

Inside of your Astro + Starlight project, you’ll see the following folders and files:

Directorydocs documentation source files
- Directorypublic/
  - …
- Directorysrc
  - Directoryassets/
    Directoryen/
    …
    Directoryru/
    …
  - Directorycomponents/
    …
  - Directorycontent/docs root (en) documentation files
    index.mdx
    Directoryru/ i18n files
    index.mdx
  - Directorystyles/
    …
  - content.config.ts
astro.config.mjs
package.json
tsconfig.json

Starlight looks for .md or .mdx files in the src/content/docs/ directory. Each file is exposed as a route based on its file name.

Images can be added to src/assets/ and embedded in Markdown with a relative link.

Static assets, like favicons, can be placed in the public/ directory.

🧞 Commands

All commands are run from the root of the project, from a terminal:

Command	Action
`npm install`	Installs dependencies
`npm run dev`	Starts local dev server at `localhost:4321`
`npm run build`	Build your production site to `./dist/`
`npm run preview`	Preview your build locally, before deploying
`npm run astro ...`	Run CLI commands like `astro add`, `astro check`
`npm run astro -- --help`	Get help using the Astro CLI

👀 Want to learn more?

Check out Starlight’s docs, read the Astro documentation, or jump into the Astro Discord server.

Go to Documentation