Polytrade Assignment

This README file provides an overview of the Polytrade "Basic Social Media Application" assignment based on NestJS with instructions on how to set up and use the application

Description

This system will support basic functionalities such as registering users, creating posts, adding friends, and liking posts.

Prerequisites

Before setting up and using the application, ensure that the following prerequisites are met:

1. Node.js and npm are installed.
2. NestJS is installed.
3. Git is installed.
4. Docker and Docker compose is installed.

Installation

To install the Polytrade "Basic Social Media Application", follow the steps below:

Clone the repository from GitHub using the command:

$ git clone git@github.com:Mutaz-Dev/polytrade.git .

Install the dependencies: using the command:

$ npm install

Environment Variables

Create .env file with the following environment variables:

DB_NAME = 
DB_USERNAME = 
DB_PASSWORD = 
DB_HOST = 
DB_PORT =   
DB_TIMEOUT =
SALT_ROUNDS = 
JWT_TOKEN_SECRET = 
JWT_EXPIRATION = 
SERVER_PORT =  

If you watn to run the application using docker, type the following commands

$ docker build -t <name-of-the-app> .
$ docker run -p <local-port>:<container-port> <name-of-the-app>

Usage

To use the application, follow the steps below:

1. Start the application:

   $ npm run start
   

   For development and debuging purposes:

   $ npm run start:dev
   

End to end testing

import the following file "Polytrade.postman_collection.json" into postman, and hit the APis

Lisence

No lisence.