diff --git a/docs/advanced/aws.md b/docs/advanced/aws.md index 9d652adf..dbe4dffa 100644 --- a/docs/advanced/aws.md +++ b/docs/advanced/aws.md @@ -2,6 +2,8 @@ sidebar_position: 2 --- +import useBaseUrl from '@docusaurus/useBaseUrl'; + # Self hosted For enhanced control over your cloud assets, you have the choice to deploy your project independently on your AWS account. This arrangement allows you to harness the capabilities of the genezio CLI without a genezio account. To accomplish this, specify the `cloudProvider` attribute in your `genezio.yaml` as `selfHostedAws`. @@ -29,7 +31,7 @@ The frontend application is hosted on S3, utilizing its static website features, Both frontend and backend code deployment employs the AWS CloudFormation service, creating separate stacks for each. -

Each class is deployed on a separate AWS Lambda. API Gateway is forwarding the request to the function that should handle that request.

+

Each class is deployed on a separate AWS Lambda. API Gateway is forwarding the request to the function that should handle that request.

:::info If your development involves a Dart application, note that you will need a genezio account for Dart code compilation in the Genezio Cloud. We're currently working on integrating with widely used build systems. diff --git a/docs/features/check-genezio-dashboard.md b/docs/features/check-genezio-dashboard.md index f1360ecc..107c4bc6 100644 --- a/docs/features/check-genezio-dashboard.md +++ b/docs/features/check-genezio-dashboard.md @@ -2,11 +2,13 @@ sidebar_position: 11 --- +import useBaseUrl from '@docusaurus/useBaseUrl'; + # Genezio dashboard To check information about all of your deployed projects, you can open a browser and navigate to the [genezio dashboard](https://app.genez.io/dashboard)[.](https://app.genez.io/dashboard) -
+
On the dashboard, you can interact with your projects as follows: diff --git a/docs/features/custom-domain-configuration.md b/docs/features/custom-domain-configuration.md index 7411f4d7..cbbfba0c 100644 --- a/docs/features/custom-domain-configuration.md +++ b/docs/features/custom-domain-configuration.md @@ -2,6 +2,8 @@ sidebar_position: 9 --- +import useBaseUrl from '@docusaurus/useBaseUrl'; + # Custom domain @@ -34,7 +36,7 @@ After you add a custom domain, we automatically configure the certificate also o In the genezio dashboard, you can go to a project that has frontend deployed, and on the frontend tab, you can set up your custom domain. -

Project page - Frontend Tab

+

Project page - Frontend Tab

On this page, you add your custom domain and click on the "Save" button. diff --git a/docs/features/email-service.md b/docs/features/email-service.md index d101147f..2c491dba 100644 --- a/docs/features/email-service.md +++ b/docs/features/email-service.md @@ -2,6 +2,8 @@ sidebar_position: 8 --- +import useBaseUrl from '@docusaurus/useBaseUrl'; + # Email Service Genezio provides a way to send emails with a managed email service. @@ -10,7 +12,7 @@ Genezio provides a way to send emails with a managed email service. On your project page, go to the integrations tab and activate the email service. -
+
### Use it in your project diff --git a/docs/features/http-methods-webhooks.md b/docs/features/http-methods-webhooks.md index a8d8e690..1eaf2bf9 100644 --- a/docs/features/http-methods-webhooks.md +++ b/docs/features/http-methods-webhooks.md @@ -2,6 +2,8 @@ sidebar_position: 6 --- +import useBaseUrl from '@docusaurus/useBaseUrl'; + # HTTP Calls / Webhooks Genezio provides an easy way to interact with third-party services or APIs using webhooks/HTTP methods. @@ -52,7 +54,7 @@ There are 2 places where you can find the webhook URLs for your deployed methods 1. In the [genezio dashboard](https://app.genez.io) on the corresponding class page: -
+
2. The HTTP endpoints will be shown in your terminal after executing `genezio deploy`: diff --git a/docs/features/project-collaboration.md b/docs/features/project-collaboration.md index 851e80ba..eb032cb9 100644 --- a/docs/features/project-collaboration.md +++ b/docs/features/project-collaboration.md @@ -2,6 +2,8 @@ sidebar_position: 10 --- +import useBaseUrl from '@docusaurus/useBaseUrl'; + # Project Collaboration :::info @@ -36,6 +38,6 @@ Full access to the project. The owner can't be changed to another user. To manage the collaborators, you should go to the project and then click on the **Collaboration** button. -
+
After you add a new collaborator/admin, they will receive an email with the invitation. diff --git a/docs/features/testing.md b/docs/features/testing.md index 5cb548d5..051d397a 100644 --- a/docs/features/testing.md +++ b/docs/features/testing.md @@ -2,6 +2,8 @@ sidebar_position: 3 --- +import useBaseUrl from '@docusaurus/useBaseUrl'; + # Testing Genezio provides a local testing infrastructure that mimics the production infrastructure on the cloud. @@ -12,11 +14,11 @@ Genezio provides a postman-like testing tool to send requests to a deployed back The testing dashboard is visually divided into 3 sections as depicted in the screenshot below: -
+
### Project Section -
alt
+
alt
The left part of the interface contains a card that will display your project in a menu-like structure. You can see your classes and their respective functions as collapsable items when you click each class. Clicking a function in the menu will open a tab for calling that specific function. @@ -26,7 +28,7 @@ At the top of the section, you have a refresh button next to the `My Workspace` The upper side of the right card is dedicated to passing arguments to your functions. -
+
At the top of the section, you will see a green-bordered label, indicating that the connection was established successfully (or a red-bordered error when failing to connect to the local environment), and a `SEND` button for calling your function. @@ -42,7 +44,7 @@ You can see the response in a `RAW` format or a `PRETTY` format available only f The upper-right part of the section will display the time it took for the request to be made and the status of the response. -
+
### Remote Testing @@ -50,19 +52,19 @@ Test your backend server in a friendly and easy-to-use graphic environment befor To access the testing dashboard, go to the genezio platform, select a deployed backend and click on the `Test project` button. -
+
You will be redirected to the testing dashboard where you can craft and send requests to the deployed backend. -
+
You can see the response received from the application in the response section: -
+
You can also check the logs from the backend in the logs section: -
+
@@ -102,7 +104,7 @@ npm install @genezio-sdk/{your-project-name}_{your-project-region} If you just want to test your genezio code without having to write any code in your client, head over to the output link [`https://app.genez.io/test-interface/local?port=8083`](https://app.genez.io/test-interface/local?port=8083) to test your project in the Genezio Test Interface: -
+
You can use the _Genezio Test Interface_ to test your projects locally, as well as remotely. Find more details about it at [testing](testing "mention"). @@ -155,8 +157,8 @@ You should see a green label indicating that your connection to the local server Sometimes, you may see a red error message at the top instead of the green success label. Most likely that means your local server is running on a different port. -
Connection Failed

Genezio Test Interface connection Failed

+
Connection Failed

Genezio Test Interface connection Failed

To establish the connection, verify on which port your server is running and fill that port in the provided input, the click `Connect` (or press Enter). -
Different port

Connect to a different port

+
Different port

Connect to a different port

diff --git a/docs/integrations/neon-postgres.md b/docs/integrations/neon-postgres.md index c59fd31b..869550a3 100644 --- a/docs/integrations/neon-postgres.md +++ b/docs/integrations/neon-postgres.md @@ -2,6 +2,8 @@ sidebar_position: 3 --- +import useBaseUrl from '@docusaurus/useBaseUrl'; + # Neon Postgres :::info @@ -16,23 +18,23 @@ A guide to integrate Neon resources in genezio projects Navigate to the project integration page in the dashboard and select to `Install` a Neon Postgres database to your project: -
+
Connect with an Neon account using the preferred login method: -
+
Create a Neon project or select an already existing project: -
+
Select the branch, database and role for the Neon project: -
+
Hit `Save` to save the database credentials as backend environment variables -
+
Use the environment variables in your genezio project to connect to the Postgres database. diff --git a/docs/integrations/sentry.md b/docs/integrations/sentry.md index 41c2a872..1f2b9d72 100644 --- a/docs/integrations/sentry.md +++ b/docs/integrations/sentry.md @@ -2,6 +2,8 @@ sidebar_position: 2 --- +import useBaseUrl from '@docusaurus/useBaseUrl'; + # Sentry :::info @@ -28,28 +30,28 @@ In order to use this integration, you will need your own Sentry account. Go to [ After you created your account, you will need also to create a project which you will later link to your genezio project. From your left-side dashboard select **Projects,** then **Create Project**. You will face a page that looks like this: -

Create Project Wizard

+

Create Project Wizard

Choose **NODE.JS**. In the next steps choose a suitable name for your project and hit **Create Project**. A pop-up will show asking if you use any frameworks. Click **Skip**. Next, you will see a page titled **Configure Node.js SDK**, providing some code samples. Those code samples allow you to manually instrument your Node.js code, in case you want to do that. The genezio integration does **NOT** require you to write any extra code, so just click **Take me to Issues**. You should now see your newly created Sentry project in your projects view. Click on it. This is where you will see errors from your genezio project. -
+
In order to link our genezio project to this Sentry project, we will need to grab the project's **DSN**. You can find this by entering the project settings (this icon in the top-right corner), in the **Client Keys (DNS)** section. Copy the value of the DSN. -

Sentry DSN

+

Sentry DSN

#### Activate the integration in the genezio dashboard Now that we have the DSN, we can switch our attention to the genezio dashboard. Go to the project for which you want to activate the integration (it must be an already deployed project), open the **Actions** dropdown, and select **Integrations** -
+
You will see the Sentry integration listed there. Click **Install** and paste the DSN that you copied earlier, then click **Connect**. After a few seconds, you will see that your integration activated successfully. From the same screen, you can also update the integration if you want to change the DSN or disable it. -
+
You should now see your crashes in your Sentry dashboard. An error should look like this: -
+
diff --git a/docs/integrations/upstash-qstash.md b/docs/integrations/upstash-qstash.md index 12528c73..8b454b7a 100644 --- a/docs/integrations/upstash-qstash.md +++ b/docs/integrations/upstash-qstash.md @@ -2,6 +2,8 @@ sidebar_position: 5 --- +import useBaseUrl from '@docusaurus/useBaseUrl'; + # Upstash Qstash ### Introduction to Upstash @@ -12,15 +14,15 @@ sidebar_position: 5 Navigate to the project integration page in the dashboard and select to `Install` Upstash QStash to your project: -
+
Connect with an Upstash account using the preferred login method: -
+
Hit `Save` to save the queue credentials as backend environment variables: -
+
Use the environment variables in your genezio project to publish to the Qstash queue. @@ -113,7 +115,7 @@ HTTP Methods Deployed: And paste it into the environments variable page to set `QUEUE_WEBHOOK_URL` environment variable. Hit `Save` to set the webhook url: -
+
To check more on how to manipulate environment variable, go to [backend-envinronment-variables](../project-structure/backend-envinronment-variables "mention"). diff --git a/docs/integrations/upstash-redis.md b/docs/integrations/upstash-redis.md index dc0880a4..b2b78b25 100644 --- a/docs/integrations/upstash-redis.md +++ b/docs/integrations/upstash-redis.md @@ -2,6 +2,8 @@ sidebar_position: 3 --- +import useBaseUrl from '@docusaurus/useBaseUrl'; + # Upstash Redis :::info @@ -17,22 +19,22 @@ A guide to integrate Upstash resources in genezio projects Navigate to the project integration page in the dashboard and select to `Install` Upstash Redis to your project: -
+
Connect with an Upstash account using the preferred login method: -
+
Create a Redis database or select an already existing database: -
+
Hit `Save` to save the database credentials as backend environment variables: -
+
Use the environment variables in your genezio project to connect to the Redis database. diff --git a/docs/project-structure/backend-envinronment-variables.md b/docs/project-structure/backend-envinronment-variables.md index a0df5159..0e1405b0 100644 --- a/docs/project-structure/backend-envinronment-variables.md +++ b/docs/project-structure/backend-envinronment-variables.md @@ -6,6 +6,8 @@ import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; +import useBaseUrl from '@docusaurus/useBaseUrl'; + # Backend Environment Variables This page describes how to set environment variables for your backend classes. @@ -18,11 +20,11 @@ To set environment variables in the backend classes, head to the [Dashboard](htt On the `Backend` tab, click on the `Environment Variables` button: -
+
Add the environment variables like a `` pair. After adding all the environment variables hit the `Save` button: -
+
Note: You can also import environment variables from a file using `Import from .env` button. diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md index d2458a1f..931ebeb5 100644 --- a/docs/troubleshooting.md +++ b/docs/troubleshooting.md @@ -2,6 +2,8 @@ sidebar_position: 10 --- +import useBaseUrl from '@docusaurus/useBaseUrl'; + # Troubleshooting Collection of frequently asked questions with ideas on how to troubleshoot and solve them. @@ -29,7 +31,7 @@ export const Model = Sometimes, you may see a red error message at the top instead of the green `Success` label. Most likely that means your local server has encountered an error or is running on a different port. -
Connection Failed

Genezio Test Interface connection Failed

+
Connection Failed

Genezio Test Interface connection Failed

To establish the connection, verify on which port your server is running and fill that port in the provided input, the click `Connect` (or press Enter). diff --git a/docusaurus.config.js b/docusaurus.config.js index 75dc432f..55933e3f 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -61,12 +61,12 @@ const config = { // Replace with your project's social card algolia: { // The application ID provided by Algolia - appId: "3H42D060PD", + appId: "01Z71RJVIP", // Public API key: it is safe to commit it - apiKey: "9c8026978d03255b35cb6875a9a757e0", + apiKey: "c944d276cc8f6ad49686ad0eacc6da01", - indexName: "genezio-genez", + indexName: "genezio", }, image: "img/genezio.svg", navbar: { diff --git a/package-lock.json b/package-lock.json index 512bac67..c87a5eb8 100644 --- a/package-lock.json +++ b/package-lock.json @@ -12601,12 +12601,6 @@ "url": "https://opencollective.com/webpack" } }, - "node_modules/search-insights": { - "version": "2.13.0", - "resolved": "https://registry.npmjs.org/search-insights/-/search-insights-2.13.0.tgz", - "integrity": "sha512-Orrsjf9trHHxFRuo9/rzm0KIWmgzE8RMlZMzuhZOJ01Rnz3D0YBAe+V6473t6/H6c7irs6Lt48brULAiRWb3Vw==", - "peer": true - }, "node_modules/section-matter": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/section-matter/-/section-matter-1.0.0.tgz", @@ -13638,19 +13632,6 @@ "is-typedarray": "^1.0.0" } }, - "node_modules/typescript": { - "version": "5.3.3", - "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.3.3.tgz", - "integrity": "sha512-pXWcraxM0uxAS+tN0AG/BF2TyqmHO014Z070UsJ+pFvYuRSq8KH8DmWpnbXe0pEPDHXZV3FcAbJkijJ5oNEnWw==", - "peer": true, - "bin": { - "tsc": "bin/tsc", - "tsserver": "bin/tsserver" - }, - "engines": { - "node": ">=14.17" - } - }, "node_modules/undici-types": { "version": "5.26.5", "resolved": "https://registry.npmjs.org/undici-types/-/undici-types-5.26.5.tgz",