Fix contributing md

This commit is contained in:
LukeGus
2025-08-31 00:47:16 -05:00
parent b649e73c80
commit 250ad975d4

View File

@@ -12,20 +12,22 @@
```sh ```sh
git clone https://github.com/LukeGus/Termix git clone https://github.com/LukeGus/Termix
``` ```
2. Install the dependencies for the server: 2. Install the dependencies:
```sh ```sh
npm install npm install
``` ```
## Running the development server ## Running the development server
Run the following command: Run the following commands:
```sh ```sh
npm run dev npm run dev
npx tsc -p tsconfig.node.json
node ./dist/backend/starter.js
``` ```
This will start the Vite server. You can access Termix by going to `http://localhost:5174/`. This will start the backend and the frontend Vite server. You can access Termix by going to `http://localhost:5174/`.
## Contributing ## Contributing
@@ -49,5 +51,6 @@ This will start the Vite server. You can access Termix by going to `http://local
## 📝 Guidelines ## 📝 Guidelines
- Follow the existing code style. Use Tailwind CSS with shadcn components. - 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. - Include meaningful commit messages.
- Link related issues when applicable. - Link related issues when applicable.