GALLERY TRACKING OPTIMIZER API

Description

A product gallery tracking and optimizer API that shows how other buyers are using/consuming the product. Go to PROJECT_DESCRIPTION.md file for the full project descripton.

APPS

Auth Resource

Company Resource

Image Resource

Event Resource

APIs

• User signup and signin
• Company registration and login
• Company upload image
• User view images

Tech Stacks

• Language -> Javascript (Node.js)
• Backend Framework -> Express
• Database -> Mongodb
• Cache - > Redis
• Cloud - > AWS S3

Setup & Installation

• Clone the project
• cd into the project directory
• Install the packages using npm or yarn

$ npm install

Environment Setup

Create '.env' file in the root directory and use the '.env.example' file to configure the necessary environment variables or use the defaults.

Running the app

$ npm run start

# watch mode
$ npm run dev

Test

# e2e tests
$ npm run test

Swagger API

Checkout the API @ the url below.
APP_PORT is default to 3000 or change it to whatever you set in the .env file.

http://localhost:3000/api-docs

Stay in touch

• contact me @ adeyeyetimothy33@gmail.com