Welcome to our Link Shortener project built using SvelteKit! Our link shortener offers minimal tracking, keeping your data private. We've designed it with a sleek and stylish interface inspired by the Catppuccin Mocha theme. As part of our commitment to openness, this project is Free and Open Source Software (FOSS). We've also implemented a secure login page with password authentication for added protection.
To get started with our link shortener, follow these simple steps:
-
Clone the Repository:
git clone https://github.com/jbugel-lol/linkShortner.git
-
Navigate to the Project Directory:
cd linkShortner -
Install Dependencies:
npm install
-
Build the Project:
npm run build
-
Run the Project:
node build
Note: Make sure to configure your Nginx or Apache2 server to listen to the port specified in the console output, typically 3000.
To use our link shortener effectively, there are a couple of additional steps to take:
-
Database Setup: You'll need to set up your own database and configure it according to your needs.
-
Environment Variables: Fill out the provided
.env.examplefile and rename it to.envwith your specific configuration. Make sure to prefix all environment variables withVITE_, as Vite requires this prefix for proper export.
To make use of our link shortener, simply visit localhost:4173 or the domain you've configured. Our user-friendly interface makes it easy to create and manage your shortened links hassle-free.
While we currently don't have specific guidelines for contributions, we welcome your involvement! Feel free to fork the project and submit pull requests for any improvements or fixes you'd like to contribute. Together, we can make this link shortener even better.