odainasser / data-api

Data parser NestJS example

NestJS Application

This is a NestJS application that provides a RESTful API for managing ingest and retrieve data. This README provides instructions on setting up and running the application locally and using Docker.

Prerequisites

Before you begin, ensure you have the following installed on your system:

• Node.js (>= 14)
• npm (comes with Node.js)
• Docker (optional, for running with Docker)
• Docker Compose (optional, for running with Docker)

Installation

1. Install dependencies:

   npm install

2. Create a .env file in the root directory and add your environment variables:

• DATABASE_HOST=localhost
• DATABASE_PORT=5432
• DATABASE_USER=your_db_user
• DATABASE_PASSWORD=your_db_password
• DATABASE_NAME=your_db_name

3. Start the application:

• npm run start:dev

  or

• docker-compose up --build

4. to use "/image-frame/upload" endpoint you can upload the file random_image_data.csv wich located in index folder provided as an example, the file built by the script in "script.py" file, you can run it on google colab to get the file by the script.