Skip to main content

Quick Start

This guide will help you get OpenATS running for the first time.

1. Clone the Repository​

Clone the OpenATS repository to your local machine.

git clone https://github.com/OpenATS/openats.git
cd openats

2. Configure Environment Variables​

Create the required environment files.

Backend​

cp backend/.env.example backend/.env

Frontend​

cp web/.env.example web/.env.local

Update the values according to the Environment Configuration guide before continuing.

3. Install Dependencies​

Install all project dependencies from the repository root.

pnpm install

4. Start the Backend​

Open a terminal and navigate to the backend directory.

cd backend
pnpm dev

The backend API will be available at:

http://localhost:8080

5. Start the Frontend​

Open a new terminal and navigate to the frontend directory.

cd web
pnpm dev

The OpenATS application will be available at:

http://localhost:3000

6. Verify Your Installation​

Once both applications are running:

  1. Open http://localhost:3000
  2. Sign in using your configured Asgardeo account
  3. Access the OpenATS dashboard
  4. Create your first hiring process
  5. Create a job opening
  6. Start managing candidates

If you can successfully access the dashboard, OpenATS has been installed correctly.

What's Next?​

Now that OpenATS is running, continue to the Local Development guide to learn about the project structure, development workflow, and contribution process.