Skip to content

Commit

Permalink
Merge pull request #25 from Genez-io/documentation-improvments
Browse files Browse the repository at this point in the history
improvments
  • Loading branch information
Virgil993 authored Feb 19, 2024
2 parents 0443b89 + 3424341 commit f290b8e
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 10 deletions.
19 changes: 19 additions & 0 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,19 @@ If you want to test it locally, you can skip this step.
genezio login
```

:::info
To install the genezio CLI you must have Node.JS >= 18.2
:::

:::info
If you are experiencing permission-denied errors on Windows, run the command below in Powershell:

```
Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
```

:::

## 3. Create a blank project

Copy this command in your terminal to start from a blank template:
Expand All @@ -79,6 +92,10 @@ Copy this command in your terminal to start from a blank template:
genezio create fullstack --frontend=onboarding-react --backend=onboarding-ts --name=genezio-project --region=us-east-1
```

:::info
The `genezio create` command can be run using the syntax above or it can be run as a standalone command which will offer a wizard through which you can configure your project.
:::

This will create the following folder structure:

```markdown
Expand Down Expand Up @@ -119,8 +136,10 @@ Now, import `GenezioDeploy` from `@genezio/types` and use it as a decorator for
<!-- {% code title="server/helloWorld.ts" lineNumbers="true" %} -->

```typescript title="server/helloWorld.ts" showLineNumbers
// highlight-next-line
import { GenezioDeploy } from "@genezio/types";

// highlight-next-line
@GenezioDeploy()
export class HelloWorldClass {
hello(name: string): string {
Expand Down
10 changes: 0 additions & 10 deletions src/theme/DocSidebar/index.js

This file was deleted.

0 comments on commit f290b8e

Please sign in to comment.