RAILWAY SETUP INSTRUCTIONS

Documentation management API with real-time MongoDB sync

🚂 Railway Service Setup - Quick Instructions

You have the Railway project "Docs Api" created. Now let's add the service.

Quick Steps

1. Add Service in Railway Dashboard

  1. Go to: https://railway.com/project/5bac6b27-44c1-47b9-a14b-f7235ae2ca87
  2. Click "+ New" or "Add a Service"
  3. Select "GitHub Repo"
  4. Select your repository
  5. Click "Add Service"

2. Configure the Service

Once created:

  1. Rename to: "backend-docs-api"
  2. Build Command: yarn install && nx build backend-docs-api --configuration=production
  3. Start Command: node dist/apis/backend-docs-api/main.js

3. Add Environment Variables

Click "Variables" and add:

NODE_ENV=production
JWT_SECRET=<copy-from-backend-api>
SYSTEM_TOKEN=<copy-from-backend-api>
MONGODB_CONNECTION_STRING_TEST_MODULES=<your-mongodb-uri>
ALLOWED_ORIGINS=https://gograb.space,http://localhost:5010

4. Configure Health Check

Settings → Health Check:

5. Deploy

Railway will auto-deploy. Watch the logs!

6. Generate Domain

Settings → Networking → "Generate Domain"

7. Test

curl https://your-domain.railway.app/docs-api/health

8. Initial Sync

export DOCS_API_URL=https://your-domain.railway.app/docs-api
export SYSTEM_TOKEN=<your-token>
yarn docs:sync

Full Guide

See: docs/english/Backend-Docs-Api/RAILWAY-SERVICE-SETUP.md


Start here: Go to your Railway project and click "+ New" to add the backend-docs-api service!