Getting Started
This guide covers the steps required to set up and run Geins Studio locally. Follow the instructions below to get started with your own instance of Geins Studio.
TIP
You can use Geins Studio managed at: https://geins.studio
Pre-requisites
- Node.js (v20.0.0 or higher)
- A Geins account - Get a free trial here
Installation
Clone the repository to create your own project:
git clone https://github.com/geins-io/geins-studio.git
cd geins-studioEnvironment variables
Create an .env file in the root of your project and add your variables. Below is a list of all available environment variables you can use in this project. Read more about AUTH_SECRET here.
| Variable | Description | Default | Required |
|---|---|---|---|
GEINS_API_URL | The URL to the Geins API | - | Always |
AUTH_SECRET | A secret key used to hash tokens, sign and encrypt cookie and generate cryptographic keys | - | Always |
BASE_URL | The URL to the application | http://localhost:3000 | In production |
GEINS_DEBUG | Geins debug flag | false | Optional |
AUTH_PATH | The path to your auth server function | /api/auth | Optional |
Theming
Geins Studio is built with shadcn-vue and is using it's theming functionality, which is based on Tailwind CSS. You can easily customize the look and feel of your application by changing the theme located in /app/assets/css/main.css.
Design system
To make it easier for you to customize the look and feel of your application, shadcn-vue has created a Figma file that you can use as you wish. You can find the file here.