# Giftyz

## Made By Space-O Technologies

## Index

1. [Introduction](#introduction)
2. [Prerequisites](#prerequisites)
3. [Installation](#installation)
4. [Running Project](#running-project)
5. [Notes](#notes)

### Introduction

- Giftyz

### Prerequisites

| **Plugin**  | **Version** |
| ----------- | ----------- |
| Node        | v22.12.0    |
| PostgresSQL | v16.6       |

### Installation

<br />

> ##### 1. ENV Variables.

- ###### Add ENV Variables as per .env.example

> ##### 2. Run this command for installing node modules.

```sh
npm install
```

> ##### 4. Create Migration and Seeder (Developer)

```sh
NAME=migration-name npm run migration:create
NAME=seed-name npm run seed:create
```

> ##### 5. Run Migrations for create database and tables

```sh
npm run build
npm run migration:run
npm run seeds:run # (First time)
NAME=SeedClassName npm run seed:run # (Recommended)
```

### Running Project

> ##### 1. For Development

```sh
npm run start:dev
```

> ##### 2. For Production

```sh
npm run start:prod
```

#### Swagger UI for ADMIN will be available @ `/admin/api/documentation`

#### Swagger UI for USER will be available @ `/api/documentation`

### Notes:

- Include the additional notes if you need to highlight for your project.

**HAPPY CODING :+1: :computer:**
