Skip to main content

Getting Started

Welcome to the "Getting Started" guide! In this tutorial, you will learn how to write a backend class, export its methods, call them from the frontend code, and then deploy both the frontend and the backend locally for testing and pushing live to a staging environment.

If you're not ready to start building yet, try Genezio in a ready-to-code environment:

Open in Gitpod

Open in GitHub Codespaces

1. Install genezio

Use your prefered package manager to install genezio:

npm install genezio -g

2. Login to the genezio cloud

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:

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:

genezio-project/
├── client/
│ └── (basic-react-app)
├── server/
│ ├── package.json
│ ├── package-lock.json
│ ├── tsconfig.json
│ └── .eslintrc.js
└── genezio.yaml

4. Create your first backend microservice

Start by creating the HelloWorldClass. It is a good practice to use separate files for each class. Let's name the file helloWorld.ts, and place it in the server folder. All the backend classes must be placed in the server folder.

Add the hello method to the newly created class. This will be the method that will be exported as a typesafe API.

server/helloWorld.ts
export class HelloWorldClass {
hello(name: string): string {
console.log("DEBUG: Call hello method");
return "Hello " + name;
}
}

Now, import GenezioDeploy from @genezio/types and use it as a decorator for the HelloWorldClassclass. This will ensure that all the public class methods will be exported as APIs.

Note: Classes that do not use this decorator remain fully private, to be called only from the backend code.

server/helloWorld.ts
// highlight-next-line
import { GenezioDeploy } from "@genezio/types";

// highlight-next-line
@GenezioDeploy()
export class HelloWorldClass {
hello(name: string): string {
console.log("DEBUG: Call hello method");
return "Hello " + name;
}
}

5. Start the genezio local environment

Run genezio local to start the genezio backend locally together with the frontend.

This command will start the backend server on port 8083 and the frontend server on port 5173.

To call the backend services from the frontend, genezio generates a Node module in the client folder. This Node module will need to be imported in your frontend code, and for now, will expose the hello method from the HelloWorldClass.

Run this command in your root project folder:

genezio local

The generated SDK supports both Typescript and Javascript using either ESM or CJS standards and uses JSON-RPC for communication.

For those who are curious, the generated code can be found in client/node_modules/@genezio-sdk/genezio-project

You are now done setting up the backend in the local environment.

Note: You can test your API using the Testing Interface provided in the genezio dashboard.

6. Call the backend method from the frontend code

Go to client/src/App.tsx and import the generated SDK:

import { HelloWorldClass } from "@genezio-sdk/genezio-project";

Next, change the sayHello function to call the server-side code. Notice how your preferred editor auto-completes the class and function call:

client/src/App.tsx
async function sayHello() {
const res = await HelloWorldClass.hello(name);
setResponse(res);
}

7. Test your app

Point the browser to http://localhost:5173 to test your app locally.

Now let's take it live for everybody to use it.

8. Deploy your full-stack app to the genezio cloud

Harness the full power of genezio by deploying both the backend and the frontend with genezio deploy. Also when you run this command, a production SDK will be generated before deploying your frontend.

Run this command in your root project folder:

genezio deploy

This is a typical part of the output that you should expect:

Deploying your backend project to genezio infrastructure...

Your backend code was deployed and the SDK was successfully generated

╭────────────────────────────────────────────────────────────────────────────────╮
│ │
│ To install the SDK in your client, run this command in your client's root: │
│ npm add @genezio-sdk/genezio-project@1.0.0-prod │
│ │
│ Then import your classes like this: │
│ import { HelloWorldClass } from "@genezio-sdk/genezio-project" │
│ │
╰────────────────────────────────────────────────────────────────────────────────╯

Deploying your frontend to genezio infrastructure...

No subdomain is specified in the genezio.yaml configuration file. We will provide a random one for you.

App Dashboard URL: https://app.genez.io/project/<projectId>/<projectEnvId>
Frontend URL: https://<subdomain>.dev.app.genez.io

After the deployment succeeds, you can access the Dashboard, check the logs of the project, and use the Test Interface to call your backend functions manually.

9. All set

Now you have a fully functional app deployed on the genezio infrastructure to be used publicly. A unique URL is created for your app. Point your browser to the link provided by the genezio deploy command: https://<subdomain>.app.genez.io . Enjoy!

Next Steps

Now that you have figured out how to write a backend class, export its methods, call them from the frontend code, and then deploy both the frontend and the backend locally for testing and pushing live to a staging environment, you are ready to take the next steps.

Let’s talk about connecting to a database. We support PostgreSQL, MongoDB, and Redis. If you do not have a database, you will learn how to provision one using a dedicated database hosting provider, with whom we partnered up:

Every application needs to handle user authentication and authorization. If you do not have an authentication provider, you can learn how to use the genezio authentication service:

Other things that do not depend on connecting to a database are scheduling the execution of a function as a cron job, or implementing HTTP Webhooks:

Also, you can find more details on deploying the backend and frontend here:

Now you are ready for some more advanced use cases:

Support

We invite you to join our community on Discord for further information and help.

Happy Learning!