Skip to main content

Local Development

This guide will help you to setup and run SAML Jackson in development mode.

Clone the repo

git clone https://github.com/boxyhq/jackson.git

cd jackson

Install dependencies

Run the following command to install the Node dependencies.

npm install

Setup environment variables

cp .env.example .env

Please refer to environment variables to read on setting environment variables.

Setup the database

Run the following command to create database instances for the local development. Make sure you have Docker installed on your machine.

npm run dev-dbs

Start the development server

Start the development server by running the following command.

npm run dev

Testing Jackson in your local environment

The Jackson service can be accessed locally using the following URL

http://localhost:5225

You can visit the following URL to see if the Jackson was started successfully!

http://localhost:5225/api/hello