🚀 RapidLink

RapidLink swiftly shortens long URLs for convenient sharing. 🚀

🔗 Links

Here’s how to set up the project on your local machine.

Prerequisites

Ensure that the following are installed on your machine:

Cloning the Repository

git clone https://github.com/piaseckijulian/RapidLink.git
cd RapidLink

Installation

pnpm i

Create Local Database

docker run --name rapidlink-db -e POSTGRES_PASSWORD=password -p 5432:5432 -d postgres

Set Up Environment Variables

Duplicate the .env.example file and rename it to .env

NEXT_PUBLIC_SITE_URL is the URL of your website. For local development, you can set it to http://localhost:3000

You can obtain both the CLERK_SECRET_KEY and NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY from Clerk's website

Set DATABASE_URL to the URL of your database. For local development, you can set it to postgresql://postgres:password@localhost:5432/postgres

After setting the DATABASE_URL, you should apply the schema by running the following command.

pnpm db:push

Running the Project

pnpm dev

That's it! - You're good to go. The projest should be live on http://localhost:3000

This software is licensed under the MIT License