Termix/CONTRIBUTING.md

Contributing

Prerequisites

• Node.js (built with v24)
• NPM
• Git

Installation

1. Clone the repository:

   git clone https://github.com/LukeGus/Termix
   

2. Install the dependencies:

   npm install
   

Running the development server

Run the following commands:

npm run dev
npm run dev:backend

This will start the backend and the frontend Vite server. You can access Termix by going to http://localhost:5174/.

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 "Feature request my new feature"
   

5. Push to your fork:

   git push origin feature/my-feature-request
   

6. Open a pull request: Go to the original repository and create a PR with a clear description.

📝 Guidelines

• Follow the existing code style. Use Tailwind CSS with shadcn components.
• Place all API routes in the main-axios.ts file. Updating the openapi.json is unneeded.
• Include meaningful commit messages.
• Link related issues when applicable.
• MobileApp.tsx renders when the users screen width is less than 768px, otherwise it loads the usual DesktopApp.tsx.

Support

If you need help with Termix, you can join the Discord server and visit the support channel. You can also open an issue or open a pull request on the GitHub repo.