Revise integrations docs

Infisical · Dec 9, 2022 · caddb45 · caddb45
1 parent 3d25baa
commit caddb45
Show file tree

Hide file tree

Showing 16 changed files with 118 additions and 182 deletions.
diff --git a/docs/getting-started/dashboard/integrations.mdx b/docs/getting-started/dashboard/integrations.mdx
@@ -4,8 +4,11 @@ title: "Integrations"
 
 Integrations allow environment variables to be synced across your entire infrastructure from local development to CI/CD and production.
 
-We're still early with integrations, but expect more soon.
+We're still early with integrations, but expect more soon. 
+
+<Card title="View integrations documentation" icon="link" href="/integrations/overview">
+  View all available integrations and their guide
+</Card>
 
 ![integrations](../../images/project-integrations.png)
 
-Check out our [integrations](/integrations/overview).
diff --git a/docs/images/project-integrations.png b/docs/images/project-integrations.png
diff --git a/docs/integrations/frameworks/django.mdx b/docs/integrations/frameworks/django.mdx
@@ -10,15 +10,18 @@ Prerequisites:
 ## Initialize Infisical for your [Django](https://www.djangoproject.com) project
 
 ```bash
-# move to your Django project
+# navigate to the root of your of your project 
 cd /path/to/project
 
-# initialize infisical
+# then initialize Infisical
 infisical init
 ```
 
-## Start your server with environment variables injected
+## Start your application as usual but with Infisical
 
 ```bash
+infisical run -- <your application start command>
+
+# Example
 infisical run -- python manage.py runserver
 ```
diff --git a/docs/integrations/frameworks/express.mdx b/docs/integrations/frameworks/express.mdx
@@ -16,30 +16,18 @@ The steps apply to the following non-exhaustive list of frameworks:
 ## Initialize Infisical for your app
 
 ```bash
-# move to your app
+# navigate to the root of your of your project 
 cd /path/to/project
 
-# initialize infisical
+# then initialize Infisical
 infisical init
 ```
 
-## Modify the start script in your `package.json`
-
-```json
-...
-"scripts": {
-    "start": "infisical run -- node index.js"
-    "dev": "infisical run -- nodemon index.js" // if using nodemon for dev
-}
-...
-```
-
-## Start your server with environment variables injected
+## Start your application as usual but with Infisical
 
 ```bash
-npm run start
-
-# or start development server
+infisical run -- <your application start command>
 
-npm run dev
+# Example
+infisical run -- npm run dev
 ```
diff --git a/docs/integrations/frameworks/fiber.mdx b/docs/integrations/frameworks/fiber.mdx
@@ -7,4 +7,21 @@ Prerequisites:
 - Set up and add envars to [Infisical Cloud](https://app.infisical.com)
 - [Install the CLI](/cli/overview)
 
-Coming soon.
+## Initialize Infisical for your [Fiber](https://gofiber.io/) app
+
+```bash
+# navigate to the root of your of your project 
+cd /path/to/project
+
+# then initialize Infisical
+infisical init
+```
+
+## Start your application as usual but with Infisical
+
+```bash
+infisical run -- <your application start command>
+
+# Example 
+infisical run -- go run server.go
+```
diff --git a/docs/integrations/frameworks/flask.mdx b/docs/integrations/frameworks/flask.mdx
@@ -10,15 +10,18 @@ Prerequisites:
 ## Initialize Infisical for your [Flask](https://flask.palletsprojects.com/en/2.2.x) app
 
 ```bash
-# move to your Flask app
+# navigate to the root of your of your project 
 cd /path/to/project
 
-# initialize infisical
+# then initialize Infisical
 infisical init
 ```
 
-## Start your server with environment variables injected
+## Start your application as usual but with Infisical
 
 ```bash
+infisical run -- <your application start command>
+
+# Example 
 infisical run -- flask run
 ```
diff --git a/docs/integrations/frameworks/gatsby.mdx b/docs/integrations/frameworks/gatsby.mdx
@@ -10,31 +10,20 @@ Prerequisites:
 ## Initialize Infisical for your [Gatsby](https://www.gatsbyjs.com) app
 
 ```bash
-# move to your app
+# navigate to the root of your of your project 
 cd /path/to/project
 
-# initialize infisical
+# then initialize Infisical
 infisical init
 ```
 
-## Modify the start script in your `package.json`
-
-```json
-...
-"scripts": {
-    "develop": "infisical run -- gatsby develop",
-    "start": "infisical run -- gatsby develop",
-    "build": "infisical run -- gatsby build",
-    "serve": "infisical run -- gatsby serve",
-    "clean": "infisical run -- gatsby clean"
-}
-...
-```
-
-## Start your development server with environment variables injected
+## Start your application as usual but with Infisical
 
 ```bash
-npm run develop
+infisical run -- <your application start command>
+
+# Example
+infisical run -- npm run develop
 ```
 
 <Note>

diff --git a/docs/integrations/frameworks/laravel.mdx b/docs/integrations/frameworks/laravel.mdx
@@ -7,4 +7,21 @@ Prerequisites:
 - Set up and add envars to [Infisical Cloud](https://app.infisical.com)
 - [Install the CLI](/cli/overview)
 
-Instructions coming soon.
+## Initialize Infisical for your [Laravel](https://laravel.com/) app
+
+```bash
+# navigate to the root of your of your project 
+cd /path/to/project
+
+# then initialize Infisical
+infisical init
+```
+
+## Start your application as usual but with Infisical
+
+```bash
+infisical run -- <your application start command>
+
+# Example 
+infisical run -- php artisan serve
+```
diff --git a/docs/integrations/frameworks/nestjs.mdx b/docs/integrations/frameworks/nestjs.mdx
@@ -10,41 +10,18 @@ Prerequisites:
 ## Initialize Infisical for your [NestJS](https://nestjs.com) app
 
 ```bash
-# move to your Next.js app
+# navigate to the root of your of your project 
 cd /path/to/project
 
-# initialize infisical
+# then initialize infisical
 infisical init
 ```
 
-## Modify the start script in your `package.json`
-
-```json
-...
-"scripts": {
-    "prebuild": "rimraf dist",
-    "build": "nest build",
-    "format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\"",
-    "start": "infisical run -- nest start",
-    "start:dev": "infisical run -- nest start --watch",
-    "start:debug": "nest start --debug --watch",
-    "start:prod": "node dist/main",
-    "lint": "eslint \"{src,apps,libs,test}/**/*.ts\" --fix",
-    "test": "jest",
-    "test:watch": "jest --watch",
-    "test:cov": "jest --coverage",
-    "test:debug": "node --inspect-brk -r tsconfig-paths/register -r ts-node/register node_modules/.bin/jest --runInBand",
-    "test:e2e": "jest --config ./test/jest-e2e.json"
-}
-...
-```
-
-## Start your server with environment variables injected
+## Start your application as usual but with Infisical
 
 ```bash
-npm run start
-
-# or start development server
+infisical run -- <your application start command>
 
-npm run start:dev
+# Example
+infisical run -- npm run start:dev
 ```
diff --git a/docs/integrations/frameworks/nextjs.mdx b/docs/integrations/frameworks/nextjs.mdx
@@ -10,33 +10,20 @@ Prerequisites:
 ## Initialize Infisical for your [Next.js](https://nextjs.org) app
 
 ```bash
-# move to your Next.js app
+# navigate to the root of your of your project 
 cd /path/to/project
 
-# initialize infisical
+# then initialize infisical
 infisical init
 ```
 
-## Modify the start script in your `package.json`
-
-```json
-...
-"scripts": {
-    "dev": "infisical run -- next dev",
-    "build": "infisical run -- next build",
-    "start": "infisical run -- next start"
-}
-...
-```
-
-## Start your server with environment variables injected
+## Start your application as usual but with Infisical
 
 ```bash
-npm run build && npm run start
-
-# or start development server
+infisical run -- <your application start command>
 
-npm run dev
+# Example
+infisical run -- npm run dev
 ```
 
 <Note>

diff --git a/docs/integrations/frameworks/nuxt.mdx b/docs/integrations/frameworks/nuxt.mdx
@@ -10,27 +10,18 @@ Prerequisites:
 ## Initialize Infisical for your [Nuxt](https://nuxtjs.org) app
 
 ```bash
-# move to your Nuxt app
+# navigate to the root of your of your project 
 cd /path/to/project
 
-# initialize infisical
+# then initialize infisical
 infisical init
 ```
 
-## Modify the start script in your `package.json`
-
-```json
-...
-"scripts": {
-    "dev": "infisical run -- nuxt",
-    "build": "infisical run -- nuxt build",
-    "start": "infisical run -- nuxt start"
-}
-...
-```
-
-## Start your development server with environment variables injected
+## Start your application as usual but with Infisical
 
 ```bash
-npm run dev
+infisical run -- <your application start command>
+
+# Example
+infisical run -- npm run dev
 ```
diff --git a/docs/integrations/frameworks/rails.mdx b/docs/integrations/frameworks/rails.mdx
@@ -10,15 +10,18 @@ Prerequisites:
 ## Initialize Infisical for your [Rails](https://rubyonrails.org) app
 
 ```bash
-# move to your Rails app
+# navigate to the root of your of your project 
 cd /path/to/project
 
-# initialize infisical
+# then initialize Infisical
 infisical init
 ```
 
-## Start your server with environment variables injected
+## Start your application as usual but with Infisical
 
 ```bash
+infisical run -- <your application start command>
+
+# Example 
 infisical run -- bin/rails server
 ```
diff --git a/docs/integrations/frameworks/react.mdx b/docs/integrations/frameworks/react.mdx
@@ -10,28 +10,18 @@ Prerequisites:
 ## Initialize Infisical for your [Create React App](https://create-react-app.dev)
 
 ```bash
-# move to your React app
+# navigate to the root of your of your project 
 cd /path/to/project
 
-# initialize infisical
+# then initialize infisical
 infisical init
 ```
 
-## Modify the start script in your `package.json`
-
-```json
-...
-"scripts": {
-    "start": "infisical run -- react-scripts start",
-    "build": "react-scripts build",
-    "test": "react-scripts test",
-    "eject": "react-scripts eject"
-}
-...
-```
-
-## Start your server with environment variables injected
+## Start your application as usual but with Infisical
 
 ```bash
-npm start
+infisical run -- <your application start command>
+
+# Example
+infisical run -- npm run dev
 ```