Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pradumnasaraf/socialslash
Access all your social media handles by endpoints.
https://github.com/pradumnasaraf/socialslash
express javascript node nodejs social-media
Last synced: 3 months ago
JSON representation
Access all your social media handles by endpoints.
- Host: GitHub
- URL: https://github.com/pradumnasaraf/socialslash
- Owner: Pradumnasaraf
- License: gpl-3.0
- Created: 2022-06-25T11:21:21.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-06-26T20:34:50.000Z (over 1 year ago)
- Last Synced: 2024-05-01T21:29:08.724Z (9 months ago)
- Topics: express, javascript, node, nodejs, social-media
- Language: JavaScript
- Homepage: https://socialslash.vercel.app
- Size: 198 KB
- Stars: 16
- Watchers: 3
- Forks: 9
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
README
Access all your social media and links by hitting endpoint.
[](https://github.com/Pradumnasaraf/SocialSlash/actions/workflows/prettier.yml) [](https://github.com/Pradumnasaraf/SocialSlash/actions/workflows/publish-ghcr.yml) [](https://github.com/Pradumnasaraf/SocialSlash/actions/workflows/linter.yml) [](https://github.com/Pradumnasaraf/SocialSlash/actions/workflows/releases.yml)
## 👨💻 Tech stack
- [Node.js](https://nodejs.org/en/)
- [Express.js](https://expressjs.com/)
- [Vercel](https://vercel.com/)
## 🚀 Using and deploying the project
- You can deploy the project on [Vercel](https://vercel.com/) 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).
[](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2FPradumnasaraf%2FSocialSlash)
- 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:
```json
{
"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 Vercel will automatically redeploy the project with your links. After the deployment is complete, 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)
## 👨💻 Developing the project
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**
[](https://gitpod.io/#https://github.com/Pradumnasaraf/SocialSlash)
**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`
```bash
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.
```js
npm run dev
```
You can access the API at `localhost:9002`
## 🛡️ License
This project is licensed under the GPL-3.0 license - see the [LICENSE](LICENSE) file for details
## 🤝 Support
If you liked the project, please consider giving it a ⭐️