Contributing to Nexterm

You plan on contributing to Nexterm? That's great! This document will guide you through the process of contributing to the project.

📦 Prerequisites

• Node.js (v18 or higher)
• Yarn
• Git

🛠️ Installation

1. Clone the repository:

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

2. Install the dependencies for the server:

   yarn install

3. Install the dependencies for the client:

   cd client
   yarn install

🏃 Running the development server

Starting the development server is as simple as running the following command:

yarn dev

This will start the server and the client in development mode. You can access the development server at http://127.0.0.1:5173.

🤝 Contributing

1. Fork the repository: Click the "Fork" button at the top right of the repository page.
2. Create a new branch:

   git checkout -b feature/my-new-feature

3. Make your changes: Implement your feature, fix, or improvement.
4. Commit your changes:

   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 repository and create a PR with a clear description.

📝 Guidelines

• Follow the existing code style.
• Keep PRs focused and minimal.
• Include meaningful commit messages.
• Link related issues when applicable.

🌍 Translations

Nexterm uses Crowdin for managing translations. If you'd like to help translate Nexterm into your language or improve existing translations, please visit our Crowdin project page.

To suggest a new language, please open an issue in the repository using the language request template. Translation pull requests will not be accepted as all translations are managed through Crowdin.