Merge pull request #22 from expatfile/development

chore: 🔖 release stable version

Author: HofmannZ

.eslintignore

@@ -1,4 +1,5 @@
 /build
 /node_modules
 /coverage
+/examples
 !.eslintrc.js

.npmignore

@@ -17,6 +17,9 @@ tsconfig.json
 # source
 /src
 
+# expamples
+/examples
+
 # misc
 .DS_Store
 .env

README.md

@@ -24,7 +24,7 @@ build time. This means you must rebuild your app for each target environment,
 which violates the principle. But what if you want, or need, to follow the build
 once, deploy many principle?
 
-### This package 🤓
+### This package 📦
 
 `next-runtime-env` solves this problem by generating a JavaScript file that
 contains the environment variables at runtime, so you no longer have to declare

examples/with-app-router/.eslintrc.json

@@ -0,0 +1,3 @@
+{
+  "extends": "next/core-web-vitals"
+}

examples/with-app-router/.gitignore

@@ -0,0 +1,36 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# next.js
+/.next/
+/out/
+
+# production
+/build
+/public/__ENV.js
+
+# misc
+.DS_Store
+*.pem
+
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# local env files
+.env*.local
+
+# vercel
+.vercel
+
+# typescript
+*.tsbuildinfo
+next-env.d.ts

examples/with-app-router/.vscode/settings.json

@@ -0,0 +1 @@
+{}

examples/with-app-router/README.md

@@ -0,0 +1,39 @@
+## Getting Started
+
+First, run the development server:
+
+```bash
+NEXT_PUBLIC_FOO=foo-value BAR=bar-value npm run dev
+# or
+NEXT_PUBLIC_FOO=foo-value BAR=bar-value yarn dev
+# or
+NEXT_PUBLIC_FOO=foo-value BAR=bar-value pnpm dev
+```
+
+Open [http://localhost:3000/client-side](http://localhost:3000/client-side) or
+[http://localhost:3000/server-side](http://localhost:3000/server-side) with your
+browser to see the development result.
+
+Next, build the app without the environment variables:
+
+```bash
+npm run build
+# or
+yarn build
+# or
+pnpm build
+```
+
+Finally, run the production server with the environment variables:
+
+```bash
+NEXT_PUBLIC_FOO=foo-value BAR=bar-value npm run start
+# or
+NEXT_PUBLIC_FOO=foo-value BAR=bar-value yarn start
+# or
+NEXT_PUBLIC_FOO=foo-value BAR=bar-value pnpm start
+```
+
+Open [http://localhost:3000/client-side](http://localhost:3000/client-side) or
+[http://localhost:3000/server-side](http://localhost:3000/server-side) with your
+browser to see the production result.

examples/with-app-router/next.config.js

@@ -0,0 +1,8 @@
+const { configureRuntimeEnv } = require('next-runtime-env/build/configure');
+
+configureRuntimeEnv();
+
+/** @type {import('next').NextConfig} */
+const nextConfig = {};
+
+module.exports = nextConfig;

examples/with-app-router/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "with-app-router",
+  "version": "0.1.0",
+  "private": true,
+  "scripts": {
+    "dev": "next dev",
+    "build": "next build",
+    "start": "next start",
+    "lint": "next lint"
+  },
+  "dependencies": {
+    "@types/node": "20.1.4",
+    "@types/react": "18.2.6",
+    "@types/react-dom": "18.2.4",
+    "eslint": "8.40.0",
+    "eslint-config-next": "13.4.2",
+    "next": "13.4.2",
+    "next-runtime-env": "link:../..",
+    "react": "18.2.0",
+    "react-dom": "18.2.0",
+    "typescript": "5.0.4"
+  }
+}