Skip to content

harshpathakzz/link-sync

Repository files navigation

Link-sync (Link in Bio App)

This project is a Link in bio application built using React.js, Vite, Firebase, Material UI, and Yarn. It provides various features for unique link, paste all links to generate a single link and analytics.

Features

  1. Paste all links: Easily paste all your important links in one place and share them with others using just one URL.
  2. Unique Link: Your Link-Sync will generate a unique link that combines all your shared links together.
  3. Analytics: Get daily, monthly, weakly and lifetime profile vists, performance of every link
  4. Custom Domain: Take full control by hosting your Link-Sync on your custom domain for a seamless experience.
  5. Authentication: Three authentication methods are available: guest login, email and password authentication, and Google login.

To-Do

The following features are planned for future development:

  1. Custom Domain: User can self host that profile at custom domain
  2. Customize Themes: User can generate custom themes according to their preference.
  3. Payment Gateway Integration: Integrate a payment gateway to enable secure online payments.

Installation and Setup

To set up the project locally, follow these steps:

  1. Ensure you have Node.js installed on your machine.

  2. Clone the repository or download the source code.

  3. Open a terminal and navigate to the project's root directory.

  4. Run the following command to install project dependencies:

    yarn
  5. Create a Firebase project and obtain the configuration details (API keys, project ID, etc.).

  6. Rename the .env.example file to .env and update the values with your Firebase configuration.

  7. Start the development server:

    yarn dev

Tech Stack

React Firebase Material UI yarn Git

The project utilizes the following technologies:

  • React.js: A JavaScript library for building user interfaces.
  • Vite: A fast build tool for modern web applications.
  • Firebase: A backend-as-a-service platform providing authentication, database, and storage services.
  • Material UI: A popular React component library for building user interfaces.
  • Yarn: A package manager for managing project dependencies.

License

This project is licensed under the MIT License. Feel free to use, modify, and distribute the code for personal or commercial purposes.

🔗 Links

linkedin twitter