Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/gnmyt/Nexterm/llms.txt

Use this file to discover all available pages before exploring further.

Nexterm is open source and welcomes contributions. Whether you are fixing a bug, adding a feature, or improving existing behavior, this page walks you through getting a local development environment running and submitting your changes upstream.

​
Prerequisites

Before you begin, make sure you have the following installed:

Node.js 18+

Nexterm requires Node.js version 18 or higher for both the server and client.

Yarn

Nexterm uses Yarn as its package manager. Install it after Node.js.

Git

You need Git to clone the repository and manage branches.

​
Setting up the project

1

Clone the repository

git clone https://github.com/gnmyt/Nexterm.git
2

Install server dependencies

From the repository root:
yarn install
3

Install client dependencies

cd client
yarn install

​
Running in development mode

Once dependencies are installed, start both the server and the client with a single command from the repository root: 
yarn dev
This starts the server and the Vite-powered client in watch mode. Open your browser and navigate to http://127.0.0.1:5173 to use the development instance.
Changes to server-side code require you to restart yarn dev. Client-side changes are hot-reloaded automatically by Vite.

​
Contributing workflow

1

Fork the repository

Click Fork at the top right of the Nexterm repository page to create your own copy on GitHub.
2

Create a branch

Use a descriptive branch name that reflects what you are working on:
git checkout -b feature/my-new-feature
3

Make your changes

Implement your feature, bug fix, or improvement. Keep your changes focused — see the code style guidelines below.
4

Commit your changes

Write a clear, meaningful commit message:
git commit -m "Add feature: my new feature"
5

Push to your fork

git push origin feature/my-new-feature
6

Open a pull request

Go to the original Nexterm repository on GitHub and open a pull request from your branch. Include a clear description of what the PR does and link any related issues.

​
Code style guidelines

Following the existing patterns in the codebase helps maintainers review and merge your contribution faster.
  • Follow existing code style. Match the formatting, naming conventions, and patterns already used in the file you are editing.
  • Keep PRs focused and minimal. One PR should address one concern. Avoid bundling unrelated changes.
  • Write meaningful commit messages. Describe what the change does and why, not just what files were touched.
  • Link related issues. If your PR addresses an open issue, reference it in the PR description (e.g., Closes #123).

​
Translations

Nexterm manages all translations through Crowdin. If you want to translate Nexterm into a new language or improve an existing translation, visit the Crowdin project page.
Translation pull requests are not accepted. All translation contributions must go through Crowdin. To request support for a new language, open an issue in the repository using the language request template.

Build docs developers (and LLMs) love

Get started for freeTalk to us