ps-devs / socialslash Goto Github PK

Access all your social media and links by hitting endpoint.

• Node.js
• Express.js
• Vercel

• You can deploy the project on Vercel by clicking the button below. It will clone the project in your GitHub account and you can deploy it on Vercel (While deploying, Vercel with ask name for the cloned project).

• The cloned project will have the default links (of Pradumna Saraf). To change the links, update the config/links.json file with your links in your cloned repository. You can add as many links as you want with custom names. The structure of the file is as follows:

{
  "github": "https://github.com/Pradumnasaraf",
  "linkedin": "https://www.linkedin.com/in/pradumnasaraf",
  "facebook": "https://www.facebook.com/pradumnasaraf.dev",
  "hashnode": "https://blog.pradumnasaraf.dev",
  "twitter": "https://twitter.com/pradumna_saraf",
  "instagram": "https://www.instagram.com/pradumnasaraf"
}

• Now you can access your links by hitting the endpoint. For example, if you want to access your GitHub profile, you can hit https://your-deployed-url-on-vercel/github and you will be redirected to your GitHub profile.

(You can also fork the project and deploy by yourself on Vercel)

This section includes how to test and develop API at your end. You can either run it in the cloud using Gitpod or run it inside a container using docker or choose to set up the complete environment locally.

GitPod

Docker Compose

Prerequisites - Docker and Compose installed in your local system.

You can run below command and you can access the API at localhost:9002

docker compose up

Local setup

Prerequisites - Node.js and npm installed in your local system. Also make sure you have cloned and installed all the dependencies.

npm run dev

You can access the API at localhost:9002

This project is licensed under the GPL-3.0 license - see the LICENSE file for details

If you liked the project, please consider giving it a ⭐️