2 posts tagged with "devops"

Vercel is a platform to host frontend applications and static sites but you can also host an express app using serverless functions. I've been using it for quite some time (mainly for frontend stuff) but it can also deploy your Expressjs backend! We will see how to create a Bridge app and deploy it to Vercel.

About Bridge.​

Bridge is a Typescript Nodejs framework that focuses on type-safety and developer experience. It aims to provide the best developer experience by simplifying the process of developing and integrating APIs.

This is done by heavily using the Typescript inference between elements from the backend such as data validation, routes and middlewares.

Prerequisites​

Having Nodejs and Vercel CLI installed on your machine.

1. Create your Bridge app​

The easiest way it to use the create-bridge-app npm package.

You can do that by using:

bash
npx create-bridge-app@latest
Copy

bash
npx create-bridge-app@latest
Copy

Then, enter your project name when prompted and select the "minimal-express" template. Once the app is created, navigate to the project directory and install the dependencies with the following command:

cd project-name && npm i
Copy

cd project-name && npm i
Copy

Step 2: Prepare your app for deployment​

By default, a Bridge app is not compatible with Vercel's serverless functions. To make it work, you need to make some changes to the app.

• Create a vercel.json file
• Edit the index.ts file
• Edit the tsconfig.json file
• Edit the package.json file

vercel.json​

Create a "vercel.json" file at the root of your project with the following content:

json
{
  "rewrites": [
    {
      "source": "/api/:path+",
      "destination": "/api"
    }
  ],
  "redirects": [
    {
      "source": "/",
      "destination": "/api"
    }
  ]
}
Copy

json
{
  "rewrites": [
    {
      "source": "/api/:path+",
      "destination": "/api"
    }
  ],
  "redirects": [
    {
      "source": "/",
      "destination": "/api"
    }
  ]
}
Copy

This file configures Vercel to redirect all requests to the "/api" route.

index.ts​

To make it work, we'll also need to update our index.ts file and initBridge on the /api route. We additionnaly add a new route GET "/api/hello".

ts
import { initBridge, handler, method } from 'bridge';
import express from 'express';
const app = express();
app.get('/api', (req, res) => res.send(`Welcome on Bridge API`));
const heyHandler = handler({
  resolve: () => {
    return 'Hey you!';
  },
});
const routes = {
  hey: method({ GET: heyHandler }),
};
app.use('/api', initBridge({ routes }).expressMiddleware());
app.listen(3000, () => {
  console.log(`Listening on port 3000`);
});
module.exports = app;
Copy

ts
import { initBridge, handler, method } from 'bridge';
import express from 'express';
const app = express();
app.get('/api', (req, res) => res.send(`Welcome on Bridge API`));
const heyHandler = handler({
  resolve: () => {
    return 'Hey you!';
  },
});
const routes = {
  hey: method({ GET: heyHandler }),
};
app.use('/api', initBridge({ routes }).expressMiddleware());
app.listen(3000, () => {
  console.log(`Listening on port 3000`);
});
module.exports = app;
Copy

Don't forget to add the module.exports = app at the end of your file.

package.json​

Update your "package.json" file with the following.

json
{
  "name": "bridge-vercel",
  "version": "1.0.0",
  "dependencies": {
    "bridge": "^2.0.45",
    "express": "^4.18.2",
    "ts-node": "^10.9.1"
  },
  "scripts": {
    "deploy": "tsc && vercel",
    "deploy-prod": "tsc && vercel --prod",
    "dev": "ts-node index.ts"
  },
  "devDependencies": {
    "@types/express": "^4.17.15",
    "@types/node": "^18.11.16",
    "typescript": "^4.9.4"
  }
}
Copy

json
{
  "name": "bridge-vercel",
  "version": "1.0.0",
  "dependencies": {
    "bridge": "^2.0.45",
    "express": "^4.18.2",
    "ts-node": "^10.9.1"
  },
  "scripts": {
    "deploy": "tsc && vercel",
    "deploy-prod": "tsc && vercel --prod",
    "dev": "ts-node index.ts"
  },
  "devDependencies": {
    "@types/express": "^4.17.15",
    "@types/node": "^18.11.16",
    "typescript": "^4.9.4"
  }
}
Copy

• npm run dev will run our development server on port 8080.
• npm run vercel builds and deploys our app to vercel in preview
• npm run deploy-prod build and deploys our app to vercel in production

tsconfig.json​

Finally, update your "tsconfig.json" file with the following content:

json
{
  "compilerOptions": {
    "target": "es2016" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */,
    "module": "commonjs" /* Specify what module code is generated. */,
    "outDir": "api" /* Specify an output folder for all emitted files. */,
    "esModuleInterop": true /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */,
    "forceConsistentCasingInFileNames": true /* Ensure that casing is correct in imports. */,
    "strict": true /* Enable all strict type-checking options. */,
    "skipLibCheck": true /* Skip type checking all .d.ts files. */
  }
}
Copy

json
{
  "compilerOptions": {
    "target": "es2016" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */,
    "module": "commonjs" /* Specify what module code is generated. */,
    "outDir": "api" /* Specify an output folder for all emitted files. */,
    "esModuleInterop": true /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */,
    "forceConsistentCasingInFileNames": true /* Ensure that casing is correct in imports. */,
    "strict": true /* Enable all strict type-checking options. */,
    "skipLibCheck": true /* Skip type checking all .d.ts files. */
  }
}
Copy

Now everything should be ready for the deployment.

npm run deploy
Copy

npm run deploy
Copy

Now you should have a fully working Bridge app deployed to Vercel. With Bridge, you can create complex APIs with a very good developer experience while using TypeScript and its type system to its fullest extent.

To read more about Bridge, check out the documentation.

Migrating a project from one framework to another can be a challenging task, but it can also bring numerous benefits such as improved performance, increased functionality, and better security. Whether you're facing outdated dependencies, changing business requirements, or simply seeking to explore new technologies, there comes a time when every project must undergo a transition.

But such thing is not always possible and sometimes the cost and effort required may not make it feasible. It is essential to weigh the benefits against the costs and determine whether migrating to a new framework is the right decision for your project.

Why would you transition to Bridge?​

Bridge is a TypeScript framework that leverages the same mechanisms as Express.js, but with an added layer of structure for improved development speed and efficiency. Its main objective is to provide type-safety across all components of your API, including middlewares, data validation, and endpoint handlers.

Additionally, Bridge can significantly reduce the boilerplate code required for a TypeScript Node.js application, making the development process faster and more streamlined. Whether you're looking to improve your backend or frontend development, Bridge provides a powerful solution that leverages the benefits of TypeScript to deliver a more efficient and scalable application.

Mixing Bridge and expressjs​

The good news is that while Bridge and Expressjs are different, they all share the same fundamental mechanisms and can co-exist inside the same project.

This means that you can continue to use your existing project while gradually incorporating new routes built with Bridge. The full migration can eventually be achieved over time.

This compatibility is achieved by integrating Bridge as an Express.js middleware, making the transition process seamless and straightforward. With this approach, you can take advantage of the benefits of Bridge while maintaining the stability and functionality of your existing project.

ts
import express from 'express';
import { handler, initBridge } from 'bridge';
const app = express();
// ...
// your existing express stuff
// ...
// Bridge
const routes = { hello: handler({ resolve: () => 'Hello' }) };
app.use('/bridge', initBridge({ routes }).expressMiddleware());
app.listen(port, () => {
  console.log(`Listening on port ${port}`);
});
Copy

ts
import express from 'express';
import { handler, initBridge } from 'bridge';
const app = express();
// ...
// your existing express stuff
// ...
// Bridge
const routes = { hello: handler({ resolve: () => 'Hello' }) };
app.use('/bridge', initBridge({ routes }).expressMiddleware());
app.listen(port, () => {
  console.log(`Listening on port ${port}`);
});
Copy

In conclusion, migrating a project to a new framework can be a challenging but rewarding experience that brings numerous benefits. Whether you're looking to improve performance, increase functionality, or explore new technologies, the process of migrating to Bridge can deliver the results you need. With its compatibility with Express.js and its ability to provide type-safety across all components of your API, Bridge offers a powerful solution for modern development.