awesome-next-runtime-env

v1.0.0

Published

2 months ago

Next.js Runtime Environment Configuration - Populates your environment at runtime rather than build time.

Downloads

0High
0Medium
0Low

unsleeping706

nextjs runtime env runtime env next-runtime-env

GitHub branch checks state

🌐 Next.js Runtime Environment Configuration

Effortlessly populate your environment at runtime, not just at build time, with next-runtime-env.

🌟 Highlights:

Isomorphic Design: Works seamlessly on both server and browser, and even in middleware.
Next.js 13 & 14 Ready: Fully compatible with the latest Next.js features.
.env Friendly: Use .env files during development, just like standard Next.js.

🤔 Why `next-runtime-env`?

In the modern software development landscape, the "Build once, deploy many" philosophy is key. This principle, essential for easy deployment and testability, is a cornerstone of continuous delivery and is embraced by the twelve-factor methodology. However, front-end development, particularly with Next.js, often lacks support for this - requiring separate builds for different environments. next-runtime-env is our solution to bridge this gap in Next.js.

📦 Introducing `next-runtime-env`

next-runtime-env dynamically injects environment variables into your Next.js application at runtime. This approach adheres to the "build once, deploy many" principle, allowing the same build to be used across various environments without rebuilds.

🤝 Compatibility Notes

Next.js 14: Use [email protected] for optimal caching support.
Next.js 13: Opt for [email protected], tailored for the App Router.
Next.js 12/13 Page Router: Stick with [email protected].

🔖 Version Guide

1.x: Next.js 12/13 Page Router
2.x: Next.js 13 App Router
3.x: Next.js 14 with advanced caching

🚀 Getting Started

In your app/layout.tsx, add:

// app/layout.tsx
import { PublicEnvScript } from 'next-runtime-env';

export default function RootLayout({ children }) {
  return (
    <html lang="en">
      <head>
        <PublicEnvScript />
      </head>
      <body>
        {children}
      </body>
    </html>
  );
}

The PublicEnvScript component automatically exposes all environment variables prefixed with NEXT_PUBLIC_ to the browser. For custom variable exposure, refer to EXPOSING_CUSTOM_ENV.md.

🧑‍💻 Usage

Access your environment variables easily:

// app/client-page.tsx
'use client';
import { env } from 'next-runtime-env';

export default function SomePage() {
  const NEXT_PUBLIC_FOO = env('NEXT_PUBLIC_FOO');
  return <main>NEXT_PUBLIC_FOO: {NEXT_PUBLIC_FOO}</main>;
}

🛠 Utilities

Need to expose non-prefixed environment variables to the browser? Check out MAKING_ENV_PUBLIC.md.

👷 Maintenance

next-runtime-env is proudly maintained by Expatfile.tax, the leading US expat tax e-filing software.

📚 Acknowledgments

Kudos to the react-env project for the inspiration, and a shoutout to @andonirdgz for the innovative context provider idea!

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme