MTR Today API

Open API for MTR HK trains schedule and fares

Usage | Development | Contributing

💻 API Documentation

• REST API
• GraphQL API

⌨️ Development

Local Development

pnpm i

# development
pnpm run start

# watch mode
pnpm run start:dev

# production mode
pnpm run start:prod

Build

pnpm run build

🤝 Contributing

🚢 Release Flow

This repo uses Release Please to release.

To release a new version

1. Merge develop into main
2. A GH Action will run(triggered automatically) and a Release PR will be created.
3. Merge the release PR
4. Wait for the second GH Action to run(triggered automatically)
5. Create merge back PR(from main back to develop)
6. You're done!