Code Monkey home page Code Monkey logo

socials's Introduction

Socials: Single Link You'll Ever Need to Share

CI/CD Code Size Issues Pull Requests

Socials is a single-page website that stores all your social media and personal websites to share. It is similar to tappy.tech, sociallinks.co, and linktr.ee, but open-source and built using Typescript, Sass, Express.js and EJS. Self-hosting or publishing as a static website or Docker is recommended!

Changelog

  • Added Phone and Email
  • Rewrote the app using Express and EJS, json file structure changed!
  • Updated the icons to a higher resolution and similar design style
  • Added several new icons (such as reddit, tumblr, dribbble, youtube and more), and rearranged the web interface to look pretty. Minor changes to display the content neatly on mobile devices.

How to add users

Users are stored in the folder /people. There is a .json file to serve as an example. The one named default.json will be binded to the base directory. The other ones will be the url directory (example if it's named felix.json then url will be https://example.com/felix)

Supported socials (for now) are:

  • Apple Music (applemusic)
  • Behance (behance)
  • Discord (discord)
  • Dribbble (dribbble)
  • Facebook (facebook)
  • Github (github)
  • Instagram (instagram)
  • Linkedin (linkedin)
  • Medium (medium)
  • Phone (phone) new
  • Pinterest (pinterest)
  • Reddit (reddit)
  • Snapchat (snapchat)
  • Spotify (spotify)
  • Tiktok (tiktok)
  • Tumblr (tumblr)
  • Twitch (twitch) new
  • Twitter (twitter)
  • Vimeo (vimeo)
  • Custom Website (website)
  • Whatsapp (whatsapp)
  • Youtube (youtube)

How to run

Docker (recommended)

docker run -d \
    --name=Socials \
    -p 7574:7574/tcp \
    -v /path/to/socials/people:/app/people \
    ghcr.io/diamkil/socials:main

Node.JS

git pull https://github.com/diamkil/socials
cd socials
yarn install (or npm i)
yarn build (or npm run build)
yarn start (or npm run start

You should be able to access the website on localhost:7574. Edit the default.json or create a new .json file with your info!

Contributing

If you are contributing, we require using yarn for development, so start the project in dev mode and happy pull requesting:

# install the dependencies
yarn install
# run the project in development
yarn dev

If something is not to your liking, feel free to open an issue here.

socials's People

Contributors

dependabot[bot] avatar diamkil avatar dunklestoast avatar hammyhavoc avatar spabolu avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

socials's Issues

Feature Request - vcard

I like your docker and I have a feature request. Would you ever consider adding a "social" that when you click it, it downloads a vcard (.vcf file) to import contact information?

How-To

can you please add some Hints...

  • how to add custom website Icons
  • how to add "Names" for Links?

Instagram

Can you support naming it Instagram and/or Insta, instead of just Insta?

Thanks!

Twitch

Would like to have Twitch.tv added in for an icon.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.