Skip to content

Commit 7151dc2

Browse files
changes
1 parent 7ccaffa commit 7151dc2

File tree

26 files changed

+75
-321
lines changed

26 files changed

+75
-321
lines changed

docs/microservices-framework/CLI.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Commands:
3636
clean clean the previous build.
3737
preview run the build in a hosted environment like production or development.
3838
gen-crud-api scans your prisma datasources and generate
39-
CRUD APIs events and workflows
39+
CRUD APIs events and event-handler functions
4040
plugin add installs eventsource and datasource plugins for godspeed.
4141
plugin remove uninstalls eventsource and datasource plugins for godspeed.
4242
plugin update update eventsource and datasource plugins
@@ -342,4 +342,4 @@ godspeed gen-graphql-schema
342342
```
343343
> 📌 Prerequisite: must have installed graphQL plugin.
344344
345-
Generates a GraphQL schema automatically from your existing Godspeed events and workflows.
345+
Generates a GraphQL schema automatically from your existing Godspeed events and functions.

docs/microservices-framework/config-and-mappings/config.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Environment variables in Godspeed are essential for securely managing configurat
3030
Environment variables can be set up using:
3131
1. **Define variables** in `config/custom-environment-variables.yaml`.
3232
2. **Set values** in `.env` or use `export` in the terminal.
33-
3. **Access variables** using `<% config.variable_path %>` in yaml and `ctx.config` in typeScript workflows.
33+
3. **Access variables** using `<% config.variable_path %>` in yaml and `ctx.config` in typeScript functions.
3434

3535
### Step 1: Define Environment Variables in YAML Configuration
3636

@@ -120,7 +120,7 @@ Once environment variables are set up, they can be accessed in Godspeed Project
120120
```
121121

122122
- **In TypeScript/JavaScript files**:
123-
Use `ctx.config` to access values within your TypeScript workflows.
123+
Use `ctx.config` to access values within your TypeScript functions.
124124

125125
**Example TypeScript function**:
126126
```typescript

docs/microservices-framework/config-and-mappings/env.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Using this file offers several advantages:
1010

1111
- **Security:** Sensitive information (like API keys and secrets) is stored outside of the codebase, helping prevent accidental exposure.
1212
- **Environment-Based Configuration:** You can specify different values for variables based on your environment, allowing seamless transitions between development, testing, and production.
13-
- **Easy Access Across the Project:** The variables defined in .env can be accessed easily in Godspeed configurations, workflows, and scripts.
13+
- **Easy Access Across the Project:** The variables defined in .env can be accessed easily in Godspeed configurations, functions and scripts.
1414

1515
.env file is placed in the root directory of your project.
1616
```

docs/microservices-framework/databases/CokroachDB.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,4 +75,4 @@ godspeed gen-crud-api
7575
```
7676
* This command will generate the crud apis based on the sample prisma schema provided at ./src/datasources/cockroachDB.prisma
7777

78-
* Now you can view the event and workflows according to the defined prisma schema
78+
* Now you can view the event and functions according to the defined prisma schema

docs/microservices-framework/databases/MariaDB.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,4 +73,4 @@ godspeed gen-crud-api
7373
```
7474
* This command will generate the crud apis based on the sample prisma schema provided at ./src/datasources/mariaDB.prisma
7575

76-
* Now you can view the event and workflows according to the defined prisma schema
76+
* Now you can view the event and functions according to the defined prisma schema

docs/microservices-framework/databases/MySQL.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,4 +91,4 @@ godspeed gen-crud-api
9191
```
9292
* This command will generate the crud apis based on the sample prisma schema provided at ./src/datasources/mysql.prisma
9393

94-
* Now you can view the event and workflows according to the defined prisma schema
94+
* Now you can view the event and functions according to the defined prisma schema

docs/microservices-framework/databases/Overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ keywords: [database integration, prisma orm, schema driven development, postgres
66

77
# Database Support Overview
88

9-
The framework takes the approach of schema driven development. It supports multiple kinds of SQL and NoSQL databases. The developer only needs to specify or generate the schema for a database, with authorization policies. The CRUD events and workflows are automatically generated from the schema itself.
9+
The framework takes the approach of schema driven development. It supports multiple kinds of SQL and NoSQL databases. The developer only needs to specify or generate the schema for a database, with authorization policies. The CRUD events and functions are automatically generated from the schema itself.
1010

1111
The framework provides functionality to access almost all popular databases through Prisma-as-datastore plugin [Plugin Repository](https://github.com/godspeedsystems/gs-plugins/tree/main/plugins/prisma-as-datastore) which is a powerful tool for efficient and secure database interactions in web applications.
1212

docs/microservices-framework/databases/PlanetScale.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,4 +76,4 @@ godspeed gen-crud-api
7676
```
7777
* This command will generate the crud apis based on the sample prisma schema provided at ./src/datasources/planetscale.prisma
7878

79-
* Now you can view the event and workflows according to the defined prisma schema
79+
* Now you can view the event and functions according to the defined prisma schema

docs/microservices-framework/databases/PostgreSQL.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,4 +89,4 @@ godspeed gen-crud-api
8989
```
9090
* This command will generate the crud apis based on the sample prisma schema provided at ./src/datasources/Postgres.prisma
9191

92-
* Now you can view the event and workflows according to the defined prisma schema
92+
* Now you can view the event and functions according to the defined prisma schema

docs/microservices-framework/databases/SQLServer.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,4 +81,4 @@ godspeed gen-crud-api
8181
```
8282
* This command will generate the crud apis based on the sample prisma schema provided at ./src/datasources/mysql.prisma
8383

84-
* Now you can view the event and workflows according to the defined prisma schema
84+
* Now you can view the event and functions according to the defined prisma schema

0 commit comments

Comments
 (0)