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.
- Paste all links: Easily paste all your important links in one place and share them with others using just one URL.
- Unique Link: Your Link-Sync will generate a unique link that combines all your shared links together.
- Analytics: Get daily, monthly, weakly and lifetime profile vists, performance of every link
- Custom Domain: Take full control by hosting your Link-Sync on your custom domain for a seamless experience.
- Authentication: Three authentication methods are available: guest login, email and password authentication, and Google login.
The following features are planned for future development:
- Custom Domain: User can self host that profile at custom domain
- Customize Themes: User can generate custom themes according to their preference.
- Payment Gateway Integration: Integrate a payment gateway to enable secure online payments.
To set up the project locally, follow these steps:
-
Ensure you have Node.js installed on your machine.
-
Clone the repository or download the source code.
-
Open a terminal and navigate to the project's root directory.
-
Run the following command to install project dependencies:
yarn
-
Create a Firebase project and obtain the configuration details (API keys, project ID, etc.).
-
Rename the
.env.example
file to.env
and update the values with your Firebase configuration. -
Start the development server:
yarn dev
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.
This project is licensed under the MIT License. Feel free to use, modify, and distribute the code for personal or commercial purposes.