Gathering detailed insights and metrics for next-runtime-env
Gathering detailed insights and metrics for next-runtime-env
Next.js Runtime Environment Configuration - Populates your environment at runtime rather than build time.
Installations
npm install next-runtime-envDeveloper Guide
BETA
Typescript
Yes
Module System
CommonJS
Node Version
20.13.1
NPM Version
10.5.2
Score
55.3
Supply Chain
79.4
Quality
80.8
Maintenance
100
Vulnerability
98.9
License
Releases
59
Contributors
12
Unable to fetch Contributors
Languages
3
TypeScript
JavaScript
Shell
TypeScript (91.45%)
JavaScript (6.06%)
Shell (2.49%)
Developer
Download Statistics
Total Downloads
2,934,605
Last Day
6,504
Last Week
63,763
Last Month
346,814
Last Year
2,714,445
GitHub Statistics
474 Stars
367 Commits
21 Forks
2 Watching
15 Branches
12 Contributors
Bundle Size
7.12 kB
Minified
2.17 kB
Minified + Gzipped
Maintainers
1
Package Meta Information
Latest Version
3.2.2
Package Id
next-runtime-env@3.2.2
Unpacked Size
71.44 kB
Size
19.27 kB
File Count
55
NPM Version
10.5.2
Node Version
20.13.1
Publised On
16 May 2024
Total Downloads
Cumulative downloads
Total Downloads
2,934,605
Last day
-61.9%
6,504
Compared to previous day
Last week
-31.2%
63,763
Compared to previous week
Last month
-5.2%
346,814
Compared to previous month
Last year
1,132.9%
2,714,445
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dev Dependencies
20
@testing-library/jest-dom@testing-library/react@types/eslint@types/jest@types/node@types/react@typescript-eslint/eslint-plugin@typescript-eslint/parseraudit-cieslint-config-airbnb-baseeslint-config-prettiereslint-plugin-importeslint-plugin-prettiereslint-plugin-simple-import-sortjestjest-environment-jsdomprettiersemantic-releasets-jesttypescript
Versions
🌐 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.
.envFriendly: Use.envfiles 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
next-runtime-env@3.xfor optimal caching support. - Next.js 13: Opt for
next-runtime-env@2.x, tailored for the App Router. - Next.js 12/13 Page Router: Stick with
next-runtime-env@1.x.
🔖 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:
1// app/layout.tsx 2import { PublicEnvScript } from 'next-runtime-env'; 3 4export default function RootLayout({ children }) { 5 return ( 6 <html lang="en"> 7 <head> 8 <PublicEnvScript /> 9 </head> 10 <body> 11 {children} 12 </body> 13 </html> 14 ); 15}
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:
1// app/client-page.tsx 2'use client'; 3import { env } from 'next-runtime-env'; 4 5export default function SomePage() { 6 const NEXT_PUBLIC_FOO = env('NEXT_PUBLIC_FOO'); 7 return <main>NEXT_PUBLIC_FOO: {NEXT_PUBLIC_FOO}</main>; 8}
🛠 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!
No vulnerabilities found.
No security vulnerabilities found.