Skip to main content

Local Setup

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:​

  1. Install Docker: Make sure Docker is installed on your workstation, and ensure you're using the latest version of Docker Compose. See instructions here.

  2. Clone the Docker Repository:

git clone https://github.com/vantikhq/docker.git
cd docker
  1. Create a .env file
cp .env.example .env
  1. Run the start script
./start.sh

Once all docker images are running, your terminal will be like below:

Cloning the Vantik Repository​

Once Docker is set up, you can proceed with cloning the Vantik repository to start development.

Steps:​

  1. Clone the Vantik Repository:
git clone https://github.com/vantikhq/vantik.git
cd vantik
  1. Create a .env file
cp .env.example .env

  1. Install pnpm

  2. Start Development Server:

pnpm dev

Upon successful execution, you should see a screen similar to this:

  1. Access the application: Navigate to http://localhost:3000. You'll be greeted with a login screen. Enter your email and click Send Magic Link.

  1. Retrieve the magic link: If you haven't provided SMTP credentials in your .env file, you won't receive the magic link via email. Instead, find it in the server logs from the previous step.

Copy the URL indicated by the red arrow (press 'c' to copy) and paste it into your browser to bypass local authentication.

  1. Provide your details to setup the your account

  1. Create your first issue: Your workspace should now look like this, type 'C' to create your first issue in your local setup.

FAQ​

If there are any questions that we couldn't answer here, feel free to open an issue on GitHub.