Code Monkey home page Code Monkey logo

librelinks's Introduction

Librelinks

Librelinks is an open-source link in bio tool for everyone.

The goal of Librelinks is to provide users with a platform that helps them manage their links and content created on social media through a single link.

Give us a star ⭐.

Official site: https://librelinks.vercel.app

βš’οΈ Demo

Create and customize your link in bio in minutes✨

Librelinks Demo

⭐ Features

It has 4 Core Features:

Feature
Description
1. Customize your page You can easily customize your page with beautiful themes and color palettes
2. Keep track of everything Get useful insights on your profile like the number of views, clicks, countries, devices etc.
3. Shareable links Share your profile everywhere with just one unique link tailor made for you
4. Privacy centered All your links belong to you, we do not sell your data.

πŸ“š Tech Stack

Category
Choice
Descriptions
Language JavaScript JavaScript (JS) is a cross-platform, object-oriented programming language used by developers to make web pages interactive.
UI Library React React’s declarative syntax and component-based architecture make it simple to develop reactive reusable components.
CSS Framework Tailwind CSS Tailwind speeds up development by providing helpful css utilities and removing the need to context switch between jsx and css files.
Web Framework NextJS 13 Next.js supports static site generation and helps build efficient React webpages that support SEO.
Database MongoDB & Prisma MongoDB is a source-available cross-platform document-oriented database program. Classified as a NoSQL database program, MongoDB uses JSON-like documents with optional schemas.
Analytics Tinybird A realtime analytics platform for data and engineering teams.

πŸ“ Project Structure

Librelinks is created with the NextJS web framework and follows its project structure.

Page Route
Code Path Description
/ /index.jsx Home page/ landing page
/components /components Contains all the components used in the project
/admin /admin/index.jsx/ The user's playground
/login and /register /login.jsx or /register.jsx The pages for authenticating the user
admin/[page] admin/[page]/index.jsx/ Individual page for customizing your profile

Environment variables πŸ”‘

You need to have the following env variables in your .env file to make the application work properly

DATABASE_URL = XXXXXXX

DEV_GITHUB_CLIENT_ID = XXXXXX

DEV_GITHUB_CLIENT_SECRET = XXXXXX

GOOGLE_CLIENT_ID = XXXXXX

GOOGLE_CLIENT_SECRET = XXXXXXXX

NODE_ENV = development

NEXTAUTH_JWT_SECRET = XXXXX

NEXTAUTH_SECRET = XXXXX

Checkout the .env.example file to learn how to get started.

πŸ’» Local Development

  1. Download the repo git clone https://github.com/urdadx/librelinks.git
  2. Change the directory cd librelinks
  3. Install the dependency npm install
  4. Start a development server npm run dev
  5. Open your browser and visit http://localhost:3000 to see Librelinks live

Contributing 🀝

We love our contributors! Here's how you can contribute:

  • Open an issue if you believe you've encountered a bug.
  • Make a pull request to add new features/make quality-of-life improvements/fix bugs.

Repo Activity

Alt

Liscence πŸ“

MIT

Give this repo a star ⭐.

librelinks's People

Contributors

urdadx avatar nginze avatar priyansumaurya avatar newtonfernandis avatar amir-hossein-karimi avatar

Stargazers

Ewanretor Giwa-Okugbe avatar

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.