Skip to content

shamsheedali/linkify

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

31 Commits
 
 
 
 
 
 

Repository files navigation

Linkify

Linkify is a modern URL shortener that enables users to create and manage short links with ease.


🛠 Tech Stack

  • Client: React, Zustand, TailwindCSS, TypeScript, Vite
  • Server: Node.js, NestJS, MongoDB, Mongoose, JWT
  • Dev Tools: Railway (hosting), Postman/Thunder Client, ESLint, Prettier

🚀 Installation

Follow these steps to set up the project locally:

1. Clone the Repository

git clone https://github.com/shamsheedali/linkify.git
cd linkify

2. Install Dependencies

Server Dependencies:

cd server
npm install

Client Dependencies:

cd ../client
npm install

3. Configure Environment Variables

Create .env files in both the server and client directories with the following example content:

server/.env

PORT=3000
MONGO_URI=your_mongodb_url
JWT_SECRET=your_jwt_secret
REFRESH_JWT_SECRET=your_refresh_secret
FRONTEND_URL=http://localhost:5173

client/.env

VITE_API_URL=http://localhost:3000/api
VITE_URL_PREFIX=http://localhost:3000/api/url/

4. Start the Application

Start the Server:

cd server
npm run start:dev

Start the Client (in a new terminal window):

cd ../client
npm run dev

📂 Project Structure

Folder Description
server Backend API server
client Frontend application

📝 Notes

  • Ensure you have Node.js and npm installed.
  • Run the server and client in separate terminal windows during development.
  • For additional configuration, refer to the README.md files inside the server and client directories (if available).

🤝 Connect


About

Linkify is a full-stack URL shortener built with the MERN stack and NestJS. It allows users to convert long URLs into short, shareable links, manage their URLs securely with JWT-based authentication, and track basic click analytics.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors