Local Setup
Run tegon in local for development
Cloning the docker Repository
To streamline your setup, we recommend using our Docker repository, which comes pre-configured with essential services like Supertokens, Typesense, Redis, and PostgreSQL. This setup also includes the server and webapp, making it easier to manage everything in one place.
Steps:
-
Install Docker: Make sure Docker is installed on your workstation, and ensure you’re using the latest version of Docker Compose. See instructions here.
-
Clone the Docker Repository:
git clone https://github.com/tegonhq/docker.git
cd docker
- Create a
.env
file
cp .env.example .env
- Run the start script
./start.sh
If you plan to work on the server or frontend locally, you can comment out the corresponding services in the Docker setup or adjust the ports as needed.
Cloning the Tegon Repository
Once Docker is set up, you can proceed with cloning the Tegon repository to start development.
Steps:
- Clone the Tegon Repository:
git clone https://github.com/tegonhq/tegon.git
cd tegon
- Create a
.env
file
cp .env.example .env
- Run Migrations and Start Development Server:
pnpm migrate
pnpm dev
FAQ
If there are any questions that we couldn’t answer here, we’d love to help you get started. Join our Slack and feel free to ask your questions in the #support channel.
Was this page helpful?