Linkr

A simple URL shortener to make your links cleaner and easier to share.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License

About The Project

Linkr is a simple URL shortener that helps you convert long, complex URLs into short, shareable links. It also supports basic analytics, such as click tracking. This tool is designed to be lightweight, easy to use, and efficient for anyone looking to make links cleaner and easier to manage.

(back to top)

Built With

• 
• 
• 
• 
• 

(back to top)

Getting Started

To get a local copy of the project up and running, follow these steps. This guide will help you set up the environment for Linkr

Prerequisites

Before you begin, make sure you have the following installed on your machine:

• Node.js (Recommended version: >= 22.12)

  • Install from: Node.js

• PostgreSQL (for database management)

  • Install from: PostgreSQL

• Redis (for caching)

  • Install from: Redis

• npm (Node package manager)

  • If you have Node.js installed, npm should be installed automatically. You can verify by running:

    npm -v

Installation

1. Clone the repo

   git clone https://github.com/BinaryBeast007/linkr.git

2. Navigate into the project directory:

   cd linkr

3. Install NPM packages

   npm install

4. Set up environment variables: Create a .env file in the root directory of the project and add the following configuration:

   DATABASE_HOST=localhost
   DATABASE_PORT=5432
   DATABASE_USER=dummyuser
   DATABASE_PASSWORD=dummypassword
   DATABASE_NAME=linkr
   DATABASE_SYNC=true
   DATABASE_AUTOLOAD=true
   JWT_SECRET=dummy_jwt_secret_key
   JWT_TOKEN_AUDIENCE=localhost:3000
   JWT_TOKEN_ISSUER=localhost:3000
   JWT_ACCESS_TOKEN_TTL=3600
   JWT_REFRESH_TOKEN_TTL=86400
   GOOGLE_CLIENT_ID=dummy-google-client-id.apps.googleusercontent.com
   GOOGLE_CLIENT_SECRET=dummy-google-client-secret
   REDIS_URL=redis://localhost:6379
   REDIS_TTL=8h

5. Start the development server: Run the following command to start the application:

   npm run start:dev

   The application should now be running locally on http://localhost:3000
6. Change git remote url to avoid accidental pushes to base project

   git remote set-url origin BinaryBeast007/linkr
   git remote -v # confirm the changes

(back to top)

Usage

The Usage section is currently in progress and will be updated with detailed examples and instructions shortly. Please stay tuned for further updates.

(back to top)

Roadmap

The roadmap is under development, and specific details will be added soon. Please check the open issues for proposed features and known issues.

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

Top contributors:

(back to top)

License

Distributed under the MIT License. See License for more information.

(back to top)