Building a Server-Side Rendered (SSR) App with Vite

Building a Server-Side Rendered (SSR) app involves orchestrating three main components: the frontend app, the SSR render entry, and the server to serve assets and handle backend APIs. In this guide, we'll leverage Vite for the frontend, Node.js and Express for the server, and demonstrate a streamlined development workflow using Nx. Prerequisites * Node.js and npm installed * Basic understanding of JavaScript, React.js (or your preferred frontend framework), and Express.js Project Structur

Post, Code and Quiet Time. Building a Server-Side Rendered (SSR) App with Vite By Errong Leng – 21 Nov 2023 – View online → Photo by Artboard Studio / Unsplash Building a Server-Side Rendered (SSR) app involves orchestrating three main components: the frontend app, the SSR render entry, and the server to serve assets and handle backend APIs. In this guide, we'll leverage Vite for the frontend, Node.js and Express for the server, and demonstrate a streamlined development workflow using Nx. Prerequisites Node.js and npm installed Basic understanding of JavaScript, React.js (or your preferred frontend framework), and Express.js Project Structure Before diving into the setup, let's outline the project structure: frontend app src/main.tsx SSR src/main.server.tsx backend app src/server.ts 3 vite configs: vite.config.ts for frontend vite.config.ssr.ts for SSR vite.config.server.ts for backend project.json: define build targets you can checkout the full example from github. GitHub - lengerrong/nx-vite-ssr-react-app Contribute to lengerrong/nx-vite-ssr-react-app development by creating an account on GitHub. GitHub•lengerrong vite.config.ts fronend app config just a normal Vite default config. export default defineConfig({ plugins: [ react(),  // import your frontend framework plugin nxViteTsPaths(), ], }); vite.config.ssr.ts SSR config export default defineConfig({ plugins: [ react(),  //yes, we need the same plugin here nxViteTsPaths(), ], build: { target: "esnext", rollupOptions: { external: ["fsevents", "esbuild", "vite", "fs", "path", "https", "http", "tls", "net", "zlib", "stream", "tty", "os", "crypto", "util"], output: { dynamicImportInCjs: true } }, copyPublicDir: false, // not copy public assets minify: false }, optimizeDeps: { esbuildOptions: { target: "esnext" }, force: true }, ssr: { // for production standalone deployment. bundle everything except the above external // so that await import main.server.mjs no need any dpes under node_modules noExternal: process.env["NX_TASK_TARGET_CONFIGURATION"] === "production" ? true : undefined } }); vite.config.server.ts backend server config same as vite.config.ssr.ts, but remove frontend plugin. Perhaps more externals need to specify not bundle for production build. Project Build Structure: project.json production build, depends on 3 parts "build": { "dependsOn": ["browser-build", "ssr-build", "server-build"], "executor": "nx:run-commands", "options": { "commands": [{ "command":"echo 'build done'" }] } }, browser build "browser-build": { "executor": "@nx/vite:build", "outputs": ["{options.outputPath}"], "defaultConfiguration": "production", "options": { "outputPath": "dist/apps/activate/browser" }, "configurations": { "development": { "mode": "development" }, "production": { "mode": "production" } } }, SSR build: use ssr and specify configFile "emptyOutDir" needs set to false, since we are using the same output path for backend entry. "ssr-build": { "executor": "@nx/vite:build", "outputs": ["{options.outputPath}"], "defaultConfiguration": "production", "options": { "emptyOutDir": false, "outputPath": "dist/apps/activate/server", "ssr": "src/main.server.tsx", "configFile": "apps/activate/vite.config.ssr.ts" }, "configurations": { "development": { "mode": "development" }, "production": { "mode": "production" } } }, Backend Build similar to SSR, use different configFile. We also need to specify the "outputFileName" as well, otherwise you will get an error while work with @nx/js:node executor. "server-build": { "executor": "@nx/vite:build", "outputs": ["{options.outputPath}"], "defaultConfiguration": "production", "options": { "outputPath": "dist/apps/activate/server", "ssr": "src/server.ts", "configFile": "apps/activate/vite.config.server.ts", "emptyOutDir": false, "outputFileName": "server.mjs" }, "configurations": { "development": { "mode": "development" }, "production": { "mode": "production" } } }, Server.ts Set SSR with Vite, please refer to https://vitejs.dev/guide/ssr. This server.ts is doing exactly same follow the doc. app.use('*', async (req, res) => { let template; if (process.env["NODE_ENV"] === "production") { template = fs.readFileSync(path.resolve(fileURLToPath(import.meta.url), '../../browser/index.html')).toString(); const { ssrRender } = await import(path.resolve(fileURLToPath(import.meta.url), '../main.server.mjs')); ssrRender(template, req, res); res.status(200); } else { const url = req.originalUrl // always read fresh template in dev template = fs.readFileSync(path.resolve(vite.config.root, './index.html'), 'utf-8') template = await vite.transformIndexHtml(url, template) const { ssrRender } = await vite.ssrLoadModule('/src/main.server.tsx'); ssrRender(template, req, res); } }) Serve Let's server our SSR app. "serve": { "executor": "@nx/js:node", "defaultConfiguration": "development", "options": { "buildTarget": "activate:build" }, "configurations": { "development": { "buildTarget": "activate:server-build:development" }, "production": { "buildTarget": "activate:server-build:production", "waitUntilTargets": ["activate:browser-build:production", "activate:ssr-build:production"] } } }, As you can observe, for development, you just need compile one file: server.ts. The server just started in less than 50ms. All the frontend part will be take over by Vite Dev Server and provide fast build, HMR and more. Conclusion Congratulations! You've successfully set up a Server-Side Rendered (SSR) app with Vite and Express, creating a powerful and efficient web application with benefits on both the frontend and backend. By leveraging Vite's capabilities for rapid frontend development, you've harnessed features like Hot Module Replacement (HMR) for instantaneous updates during development. Combining this with an Express server allows you to achieve server-side rendering, providing improved performance and search engine optimization. The use of Nx has streamlined your development workflow, enabling watch mode for both frontend and backend applications. This ensures that any changes made to your code trigger automatic rebuilds, enhancing productivity and reducing development time. As you move forward, consider exploring additional features and optimizations for your SSR app, such as: Optimizing SSR Render Entry: Fine-tune the SSR render entry point for performance improvements and better server-side rendering results. Middleware and API Enhancements: Extend your Express server with middleware for additional functionalities and enhance your backend APIs to meet the requirements of your application. Testing and Deployment Strategies: Implement thorough testing procedures for both the frontend and backend components. Explore deployment options, such as containerization or serverless architectures, based on your application's needs. Remember to refer to official documentation and community resources for ongoing support and updates on the tools and frameworks you've used in this setup. Now, with a robust SSR app in place, you're well-equipped to deliver a seamless user experience while taking advantage of the best features that Vite and Express have to offer. Happy coding! Post, Code and Quiet Time. © 2023 – Unsubscribe

Building an Backend App with Vite: A Comprehensive Guide

Introduction: Leveraging Vite for Express Backend Development Traditionally recognized as a powerful frontend build tool, Vite has become synonymous with rapid development, efficient bundling, and seamless hot module replacement in the world of web development. However, the utility of Vite extends beyond the boundaries of frontend applications, making it a compelling choice for optimizing the development workflow of Express backend applications. In this guide, we'll explore how you can harness

Post, Code and Quiet Time. Building an Backend App with Vite: A Comprehensive Guide By Errong Leng – 20 Nov 2023 – View online → Photo by Monika Borys / Unsplash Introduction: Leveraging Vite for Express Backend Development Traditionally recognized as a powerful frontend build tool, Vite has become synonymous with rapid development, efficient bundling, and seamless hot module replacement in the world of web development. However, the utility of Vite extends beyond the boundaries of frontend applications, making it a compelling choice for optimizing the development workflow of Express backend applications. In this guide, we'll explore how you can harness the speed and configurability of Vite to streamline the development and build processes of your Express backend. By merging the strengths of Vite's build system with the robustness of Express, developers can achieve a harmonious blend of efficiency and performance, ultimately enhancing the overall development experience. This exploration into using Vite with Express opens up new possibilities for developers seeking to unify their stack, providing a cohesive environment that facilitates rapid iteration, code splitting, and a modern development experience for both frontend and backend components. Join us on this journey as we delve into the steps of setting up, configuring, and integrating Vite within an Express application, unlocking a synergistic approach that promises to redefine your backend development workflow. Step 1: Creating an Express App via Nx In this initial step, we'll leverage Nx, a powerful toolkit for monorepo development, to scaffold our Express app. Install Nx CLI: Start by installing Nx globally on your machine: npm install -g create-nx-workspace Create Express App: Use Nx to generate a new Express app within your workspace: npx create-nx-workspace --preset=express Explore Nx Express Capabilities: Take a moment to explore the Nx capabilities for Express development. Nx simplifies monorepo management, making it an ideal choice for projects of any scale. Executing task: npx nx run vite-backend-app:serve nx run vite-backend-app:serve:development chunk (runtime: main) main.js (main) 841 bytes [entry] [rendered] webpack compiled successfully (1ac9127e4c838d67) Debugger listening on ws://localhost:9229/85766bec-fca0-4272-8092-1305151fed78 Debugger listening on ws://localhost:9229/85766bec-fca0-4272-8092-1305151fed78 For help, see: https://nodejs.org/en/docs/inspector Listening at http://localhost:3333/api curl http://localhost:3333/api {"message":"Welcome to vite-backend-app!"}% @nx/webpack:webpack is the default build tool Step 2: Modifying the Express App to Use Vite Integrating Vite for Streamlined Development Now that our Express app is set up, let's seamlessly integrate Vite to supercharge the development process. Install Vite deps and use it as build npm install --save-dev @nx/vite build looks good. First serve error: The "path" argument must be of type string. Received undefined Check this fix, "outputFileName": "main.mjs" @nrwl/js:node can’t work with @nrwl/vite:build · Issue #14760 · nrwl/nx I’d be willing to implement this feature (contributing guide) Description I have a build target build by vite build executor. “build”: { “executor”: ”@nrwl/vite:build”, “outputs”: [”{options.output... GitHub•nrwl Run time error: ReferenceError: __dirname is not defined in ES module scope The __dirname variable is commonly used in CommonJS modules to get the directory name of the current module. However, in ECMAScript (ES) modules, which have a different module syntax (import and export), __dirname is not available by default. To address the ReferenceError: __dirname is not defined issue in an ES module, you can use the following workaround: Use import.meta.url: In an ES module, you can use import.meta.url to get the URL of the current module file and then extract the directory name. Here's an example:javascriptCopy codeimport { fileURLToPath } from 'url'; import { dirname } from 'path'; const __filename = fileURLToPath(import.meta.url); const __dirname = dirname(__filename); // Now you can use __dirname in your code console.log(__dirname); In this example, the fileURLToPath function from the 'url' module is used to convert the import.meta.url to a file path, and then the dirname function from the 'path' module is used to get the directory name. Use Node.js __filename and __dirname global variables: If you are running your code in a Node.js environment, you can use the __filename and __dirname global variables directly without the need for import.meta.url:javascriptCopy code// This check is necessary to avoid issues when using this code in a bundler if(typeof __filename === 'undefined') { global.__filename = import.meta.url;global.__dirname = path.dirname(import.meta.url); } // Now you can use __dirname in your code console.log(__dirname); This code sets __filename and __dirname as global variables if they are not defined, making them accessible throughout the module. Choose the approach that best fits your environment and requirements. If you're working in a modern ES module environment, the first approach is recommended. If you're working in a Node.js environment, the second approach might be more straightforward. Modify main.ts, Save it, HMR works and server restarted automatically for you. The same out come for the api. Conclusion: In this guide, we embarked on a journey to unite Express backend development with the cutting-edge capabilities of Vite. By leveraging Nx for project structuring and seamlessly integrating Vite into our Express app, we've redefined the backend development workflow. This fusion presents a powerful toolkit for developers, offering efficiency, performance, and a unified environment for frontend and backend components. As you experiment with these techniques, you'll discover the endless possibilities that arise from the integration of Vite with Express. The synergy achieved promises to elevate your development experience, providing a modern and efficient foundation for building web applications. Embrace this convergence, explore the nuances, and unlock the full potential of combining Vite with Express in your projects. Checkout the full example from github. Post, Code and Quiet Time. © 2023 – Unsubscribe