> For the complete documentation index, see [llms.txt](https://yasdpt.gitbook.io/instaquiz/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://yasdpt.gitbook.io/instaquiz/setup/requirements.md).

# Requirements

To be able to run the application and develop it in your local environment you need tools below installed.

## Git and Github

For cloning and managing versioning of the application you need to have git installed on your system.

You can follow instructions on this page to get started with git: <https://github.com/git-guides/install-git>

Also an account on Github, sign up at: <https://github.com/signup>

## Node

You can install node from: <https://nodejs.org/en/download>

and you can follow these instructions for installing it: <https://nodejs.dev/en/learn/how-to-install-nodejs/>

## PNPM

pnpm was used for managing node packages in the project.

Installation on Windows:

```powershell
iwr https://get.pnpm.io/install.ps1 -useb | iex
```

Installation on Mac and Linux:

```bash
curl -fsSL https://get.pnpm.io/install.sh | sh -
```

For more information on installing pnpm go to: <https://pnpm.io/installation>

## Database

Postgresql was used for the database of the project, you're free to use any database provider or setup your own server. I used the free tier of [Neon](https://neon.tech) as it is a good fit for the project usage.

You can sign up at[ https://console.neon.tech](https://console.neon.tech)

Creating the database documentation: <https://neon.tech/docs/get-started-with-neon/setting-up-a-project>

## IDE

You can use [VSCode](https://code.visualstudio.com/download) or any ide you like for the development of this application.