Linki - Share Your Links Efficiently

Author

• Author: Brian Waweru

Project Description

Linki is a web application that empowers users to create a personalized landing page, simplifying the process of sharing multiple online links from a single, unified platform.

You can find links to the deployed app here:

• Frontend - To be deployed
• Backend - To be deployed

Here's the link to the Linki API.

Table of Contents

• Linki - Share Your Links Efficiently
  • Author
  • Project Description
  • Table of Contents
  • Introduction
  • Key Features
    • 1. Landing Page
    • 2. Link and Contact Management
    • 3. User-Specific Link Display
  • Getting Started
  • Usage
  • Contributing
  • License

Introduction

Sharing multiple online links can be cumbersome and confusing, especially when you want to direct others to your various social media profiles, personal website, or portfolio. Linki aims to solve this problem by providing a user-friendly platform to create and manage your personal landing page, making it easy for you to share all your important links in one place.

Key Features

1. Landing Page

• A stylish landing page summarizes the app's purpose and functionality.
• Users can log in or register for an account.

2. Link and Contact Management

• Users can add, edit, and organize their links and contact information.
• Each set of links can be associated with a unique name, creating a personalized link for easy access (e.g., linki.com/dexter).

3. User-Specific Link Display

• Users have a dedicated page that displays their added links, social media profiles, and contact details.

Getting Started

Follow these steps to get started with Linki:

1. Clone the repository to your local machine.

   git clone https://github.com/your-username/linki.git

2. Install the necessary dependencies.

   cd linki
   npm install

3. Start the development server.

   npm run dev

4. Open your web browser and navigate to http://localhost:5173 to access the application.

Usage

1. Landing Page: Upon accessing the app, you will be greeted with a welcoming landing page. You can log in if you have an account or register for a new one.

2. Link and Contact Management: Once logged in, you can add and edit your links and contact information. Each set of links can be associated with a unique name, which will create a personalized link for easy sharing.

3. User-Specific Link Display: Your dedicated link (linki.com/your-username) will display all the links, social media profiles, and contact details you have added.

Contributing

We welcome contributions from the community. If you would like to contribute to Linki, please follow these steps:

1. Fork the repository on GitHub.
2. Create a new branch for your feature or bug fix.
3. Make your changes and commit them with descriptive commit messages.
4. Push your changes to your fork.
5. Submit a pull request to the main repository's develop branch.

License

This project is licensed under the MIT License - see the LICENSE file for details.