Skip to content

valishah/preview

Repository files navigation

Preview javascript style guide

This repo has the API for fetching preview information of a specific url. Which includes the meta information required to represent in social media platforms like twitter, facebook etc.

Tech Stack

  • NodeJS
  • Express
  • GCP(Google Cloud Platform)

Install Depedencies

Install Gcloud

gcloud sdk is required for deploying application to google cloud, to install gcloud visit https://cloud.google.com/sdk/downloads

Install App Dependencies

Before running make sure you install the required dependencies by running command,

npm install

Running the app

To run the application in local, run command

npm start

which will start the local server in Demon mode with NODE_ENV variable set as development

Running test cases

To run test cases, run command

npm test