|
| 1 | +# Contributing to Fathom MCP |
| 2 | + |
| 3 | +Thanks for your interest in contributing! |
| 4 | + |
| 5 | +## Development Setup |
| 6 | + |
| 7 | +Fathom OAuth apps require HTTPS redirect URIs, so you'll need to deploy to test the full OAuth flow. |
| 8 | + |
| 9 | +### 1. Fork and Deploy |
| 10 | + |
| 11 | +1. Fork this repository |
| 12 | +2. Deploy to [Railway](https://railway.app) (free tier works) |
| 13 | +3. Add a PostgreSQL database to your project |
| 14 | +4. Set environment variables (see README) |
| 15 | + |
| 16 | +### 2. Create Your Own Fathom OAuth App |
| 17 | + |
| 18 | +1. Go to [Fathom Developer Portal](https://developers.fathom.ai/oauth) |
| 19 | +2. Register a new app pointing to your deployed URL |
| 20 | +3. Set redirect URI: `https://your-app.railway.app/oauth/fathom/callback` |
| 21 | + |
| 22 | +### 3. Initialize Database Schema |
| 23 | + |
| 24 | +After adding a PostgreSQL database to your Railway project (step 1.3) and copying `DATABASE_URL` to your local `.env`, create the tables: |
| 25 | + |
| 26 | +```bash |
| 27 | +npm run db:push |
| 28 | +``` |
| 29 | + |
| 30 | +This connects to your Railway database and creates the required tables. |
| 31 | + |
| 32 | +### 4. Test Your Changes |
| 33 | + |
| 34 | +1. Make changes locally |
| 35 | +2. Push to your fork (Railway auto-deploys) |
| 36 | +3. Test via Claude Desktop connected to your deployment |
| 37 | + |
| 38 | +## Code Style |
| 39 | + |
| 40 | +- Run `npm run ci` before committing (runs lint, typecheck, and build) |
| 41 | +- Run `npm run format` to auto-format with Prettier |
| 42 | +- Follow existing patterns in the codebase |
| 43 | + |
| 44 | +## Project Structure |
| 45 | + |
| 46 | +``` |
| 47 | +src/ |
| 48 | +├── db/ # Database schema and connection |
| 49 | +├── middleware/ # Express middleware (auth, errors, logging, rate limiting) |
| 50 | +├── modules/ # Feature modules |
| 51 | +│ ├── fathom/ # Fathom API integration |
| 52 | +│ ├── oauth/ # OAuth flow handling |
| 53 | +│ └── sessions/ # MCP session management |
| 54 | +├── routes/ # Express route definitions |
| 55 | +├── shared/ # Shared config, constants, errors, schemas |
| 56 | +├── tools/ # MCP tool definitions and handlers |
| 57 | +└── utils/ # Utility functions |
| 58 | +``` |
| 59 | + |
| 60 | +## Pull Requests |
| 61 | + |
| 62 | +1. Create a feature branch from `main` |
| 63 | +2. Make your changes |
| 64 | +3. Run `npm run ci` to ensure all checks pass |
| 65 | +4. Submit a PR with a clear description of what changed and why |
| 66 | + |
| 67 | +## Reporting Issues |
| 68 | + |
| 69 | +- Check existing issues first |
| 70 | +- Include steps to reproduce |
| 71 | +- Include relevant error messages or logs |
| 72 | + |
| 73 | +## Questions? |
| 74 | + |
| 75 | +Open an issue or discussion if something is unclear. |
0 commit comments