# # Running Locally

> This guide explains how to install the Development version of Gitaflow locally so that you can work on the platform's source code. To install the Production version locally, please follow to our standard installation guides.

Minimum Requirements

You will need to have the latest version of Node
(opens new window) to build a Development version of Gitaflow.

You can use the JavaScript tool manager volta
(opens new window) to automatically install the current node and npm versions.

## # 1. Fork the Gitaflow repository

Go to the repository
(opens new window) and fork it to your GitHub account. A fork is your copy of the Gitaflow repository. Forking the repository allows you to freely experiment with changes without affecting the original project.

## # 2. Clone from your repository

    git clone git@github.com:YOUR-USERNAME/gitaflow.git

## # 3. Make a new branch

    git checkout -b YOUR-BRANCH-NAME

## # 4. Install the dependencies and build the project

    npm install
    npm run build

## # 5. Create a `.env` file

Create an `.env` file under the `api` folder using vars from the online config help
(opens new window)

## # 6. Initialize the database

For this step, you'll need to already have a SQL database up-and-running, except if you're using the SQLite driver, which will create the database (file) for you.

To start the initialization run the following command:

    # From within the root of the project
    npm run cli bootstrap

    # For SQLite you need to run the command in the 'api' context (to ensure the database file is created in the right directory)
    npm run cli bootstrap --workspace=api

This will set-up the required tables for Gitaflow and make sure all the migrations have run.

## # 7. Start the development server

First you need to choose what packages you want to work on. Then, you should run the `dev` script on that package. You can see their names and list of scripts in their related `package.json`. Example of running APP:

    npm run dev -w @gitaflow/app

If you want to work on multiple packages at once, you should create a new instance of your terminal for each package: Example of running Api, App:

Terminal 1 [Api] | Terminal 2 [App]
--- | ---
    npm run dev -w gitaflow
    npm run dev -w @gitaflow/app

To work on the Documentation (public website version), you should navigate to the `docs` directory and run the following command:

    npm install

ℹ This is necessary because the way vue-server-renderer imports vue

Then you should run

    npm run dev:site

TIP

If you encounter errors during this installation process, make sure your node version meets the minimum requirements

## # 8. Make your fixes/changes

At this point you are ready to start working on Gitaflow! Before diving in however, it's worth reading through the introduction to Contributing.

Debugging

Check our Wiki for a guide
(opens new window) on debugging the app and api.

## # 9. Running tests

Tests run automatically through GitHub Actions. However you may wish to run the tests locally especially when you write tests.

Install Docker
(opens new window) and ensure that the service is running.

    # Ensure that you are testing on the lastest codebase
    npm run build

    # Clean up in case you ran the tests before
    docker compose -f tests/docker-compose.yml down -v

    # Start the necessary containers
    docker compose -f tests/docker-compose.yml up -d --wait

    # Run the tests
    npm run test:e2e