Deploying a Web Service to a Hosting Platform

Pre-flight Check: Configure Your Server for Deployment

Before we deploy, we need to make one critical adjustment to your main server file (likely app.js or index.js).

Hosting platforms like Render and Railway assign a port to your application automatically. Your code must listen on the port provided by the platform's environment. You can access this through process.env.PORT.

To handle both local development (e.g., on port 3001) and production deployment, update the line where you start your server:

// Find this line in your main server file:
// app.listen(3001, () => { ... });

// And change it to this:
const PORT = process.env.PORT || 3001;

app.listen(PORT, () => {
  console.log(`Server is running on port ${PORT}`);
});

This code tells your app: "Use the port defined by the hosting environment, but if it's not defined (i.e., we're running locally), default to port 3001."

Your Task:

1. Make this change in your server file.
2. Commit and push this update to your GitHub repository before proceeding.

   git add .
   git commit -m "feat: configure dynamic port for deployment"
   git push
   

Step 1: Choose Your Deployment Platform

Both Render and Railway are excellent choices for deploying Node.js applications. They connect directly to GitHub and offer generous free tiers. The core concepts are identical. For the exam, being proficient with one is all you need.

• Render: Very explicit and structured. You define each step clearly (build command, start command). Great for understanding the process.
• Railway: Highly automated. It often infers settings for you, leading to a faster initial setup.

Review the options below and pick the one that feels more intuitive to you.

Path A: Deploying with Render

Render provides a step-by-step interface for configuring your web service.

Action 1: Sign Up and Create a Web Service

First, create a Render account and link it to GitHub. Then, you'll create a "Web Service" which will host your API.

Action 2: Configure and Deploy

This video provides a concise visual walkthrough of the configuration process you just read about. It shows exactly where to input the required commands.

Your Task (Render):

1. Sign up for Render with your GitHub account.
2. On the dashboard, click New + > Web Service.
3. Select your API's GitHub repository and click Connect.
4. On the configuration screen:
   • Give your service a unique Name (e.g., my-api-exam-service).
   • Ensure the Region is close to you.
   • Set the Build Command to npm install.
   • Verify the Start Command is npm start.
   • Select the Free instance type.
5. Do not add any environment variables yet.
6. Scroll down and click Create Web Service.

You will be taken to a log screen where you can watch your deployment happen in real-time.

Path B: Deploying with Railway

Railway streamlines deployment with a "deploy first, configure later" philosophy.

Action 1: Sign Up and Deploy from GitHub

You'll start by creating a new project on Railway and immediately linking it to your GitHub repository.

Action 2: Watch the Magic Happen

This video demonstrates the Railway workflow. Notice how quickly it starts building once the repository is selected.

Your Task (Railway):

1. Sign up for Railway with your GitHub account.
2. On the dashboard, click New Project.
3. Select Deploy from GitHub repo.
4. Configure access to your GitHub account if prompted.
5. Select your API's GitHub repository from the list.
6. Railway will immediately start building and deploying your project. You can click on the new service block to view the deployment logs.

What to Expect: An Expected "Failure"

After you initiate the deployment on either platform, the build will likely succeed (npm install will run), but the deployment will then fail or enter a "crash loop."

You will see errors in the logs like:

• MongoParseError: Invalid connection string
• Cannot connect to database
• The server continuously restarting.

This is expected and is a good sign! It means the platform has successfully pulled your code and tried to run it. The failure is happening because your deployed application has no idea how to connect to your MongoDB database. The MONGO_URI it needs is in your local .env file, which you correctly did not push to GitHub.

Conclusion

You have successfully linked your code to a live hosting environment. The platform is now set up to automatically redeploy your application every time you push a new commit to your main branch. Although the app is currently crashing, you've completed the foundational step of deployment.

Key Takeaways:

• Modern hosting platforms like Render and Railway deploy directly from a GitHub repository.
• Your application must be configured to use process.env.PORT to run correctly in a hosted environment.
• The deployment process involves specifying a build command (npm install) and a start command (npm start).
• It is normal for the first deployment to fail if it depends on environment variables that have not been configured yet.

Next Up:

In the next lesson, we will fix the crash. You will learn how to securely provide your MONGO_URI and any other necessary secrets to the production environment using the hosting platform's dashboard, allowing your application to connect to the database and run successfully.