Skip to content
/ links Public

A personal website and Linktree alternative that consolidates all my information, projects, and social media links in one place.

License

Notifications You must be signed in to change notification settings

UmmItC/links

Repository files navigation

Links - Your Personal Landing Page 🔗

Release semantic-release: angular License: GPL v3

A modern, minimalist landing page that serves as your digital business card. Inspired by Linktree, but enhanced with custom features and a sleek design. Perfect for creators, developers, and professionals who want to share their online presence elegantly.

Tech Stack

  • Frontend: React + Vite (Typescript)
  • Styling: Tailwind CSS for Style
  • Components: DaisyUI for Style components
  • CI/CD: GitHub Actions for automated deployment
  • Versioning: Semantic Release for automated detection versioning
  • Hosting: GitHub Pages

Getting Started

Prerequisites

  • Node.js
  • Yarn package manager

Development Setup

  1. Clone the repository:

    git clone https://github.com/UmmItC/links.git
    cd links
  2. Install dependencies:

    yarn install
  3. Start the development server:

    yarn run dev
  4. View your site at http://localhost:5173

Production Build

Create a production-ready build:

yarn run build

Preview the production build:

yarn run preview

The static files will be generated in the dist/ directory.

Deployment Options

GitHub Pages (Recommended)

This project includes automated deployment to GitHub Pages through GitHub Actions workflows (see .github/ directory).

Simply push your changes to the master branch, and the site will be automatically:

  • Built
  • Versioned
  • Deployed

Development Guidelines

Commit Convention

We follow the Conventional Commits specification:

feat: add new feature
fix: resolve an issue
docs: update documentation
style: formatting changes
refactor: code restructuring
test: add/update tests
chore: maintenance tasks

Branch Strategy

  • master: Production-ready code (do not use this branch, since it's the Production branch)
  • dev: Development and integration
  • Feature branches: feature/your-feature-name

License

This project is licensed under the GNU General Public License v3.0 - see the LICENSE file for details.

Contributing

There are many ways to contribute, such as recommending features, reporting bugs, fixing documentation typos, and more.

If you would like to open a Pull Request (or Merge Request), please review this document first before making any commits or fixes: CONTRIBUTING.md.

Thank you for your interest in contributing!

About

A personal website and Linktree alternative that consolidates all my information, projects, and social media links in one place.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 3

  •  
  •  
  •