k1nq/TREK
1
0
Fork 0
mirror of https://github.com/mauriceboe/TREK.git synced 2026-06-19 13:21:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(wiki): add Contributing and Development-environment to sidebar and cross-links

Browse Source
This commit is contained in:
jubnl
2026-04-21 16:52:38 +02:00
parent 5a64d8994e
commit d59b3334dc
4 changed files with 9 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files
wiki/Contributing.md
+1 -17
View File
@@ -51,23 +51,7 @@ Include:
## Development Setup ## Development Setup
```bash See the [[Development Environment|Development-environment]] page for the full setup guide, including forking, remote configuration, branch conventions, and available scripts.
git clone https://github.com/mauriceboe/TREK.git
cd TREK
# Server
cd server
npm install
npm run dev
# Client (separate terminal)
cd client
npm install
npm run dev
```
- Server runs on `http://localhost:3001`
- Client runs on `http://localhost:5173` (with proxy to server)
## Tech Stack ## Tech Stack
wiki/Development-environment.md
+2 -2
View File
@@ -1,6 +1,6 @@
# Developer Setup Guide # Developer Setup Guide
> Before anything else, please read the [Contributing Guidelines](https://github.com/mauriceboe/TREK/blob/main/CONTRIBUTING.md). > Before anything else, please read the [[Contributing]] guidelines.
## Prerequisites ## Prerequisites
@@ -135,4 +135,4 @@ Then open a Pull Request from your fork to `mauriceboe/TREK` targeting the `dev`
- Always branch off from an up-to-date `dev` — run `git fetch upstream && git rebase upstream/dev` before starting new work. - Always branch off from an up-to-date `dev` — run `git fetch upstream && git rebase upstream/dev` before starting new work.
- Run tests before pushing: `npm run test` in both `client/` and `server/`. - Run tests before pushing: `npm run test` in both `client/` and `server/`.
- Follow the commit message conventions described in the [Contributing Guidelines](https://github.com/mauriceboe/TREK/blob/main/CONTRIBUTING.md). - Follow the commit message conventions described in the [[Contributing]] guidelines.
wiki/Home.md
+2
View File
@@ -58,3 +58,5 @@ TREK is a self-hosted, real-time collaborative travel planner licensed under AGP
| [My Trips Dashboard](My-Trips-Dashboard) | Start planning your first trip | | [My Trips Dashboard](My-Trips-Dashboard) | Start planning your first trip |
| [Admin Panel](Admin-Panel-Overview) | Configure your instance | | [Admin Panel](Admin-Panel-Overview) | Configure your instance |
| [MCP / AI Integration](MCP-Overview) | Connect Claude, Cursor, or any MCP client | | [MCP / AI Integration](MCP-Overview) | Connect Claude, Cursor, or any MCP client |
| [Contributing](Contributing) | Guidelines for submitting pull requests |
| [Development Environment](Development-environment) | Set up a local dev environment |
wiki/_Sidebar.md
+4
View File
@@ -92,3 +92,7 @@
## Help ## Help
- [[FAQ]] - [[FAQ]]
- [[Troubleshooting]] - [[Troubleshooting]]
## Contributing
- [[Contributing]]
- [[Development Environment|Development-environment]]