https://github.com/krish-makadiya/nano.link
NanoLink is a robust URL shortening platform built with the MERN stack and Next.js, offering streamlined link management, custom aliases, and detailed analytics.
https://github.com/krish-makadiya/nano.link
analytics custom-aliases express-js full-stack-development link-management mern-stack mongodb next-js node-js open-source react-js responsive-design tailwind-css url-shortener web-development
Last synced: about 2 months ago
JSON representation
NanoLink is a robust URL shortening platform built with the MERN stack and Next.js, offering streamlined link management, custom aliases, and detailed analytics.
- Host: GitHub
- URL: https://github.com/krish-makadiya/nano.link
- Owner: Krish-Makadiya
- Created: 2025-01-06T03:18:26.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2025-02-07T04:54:18.000Z (3 months ago)
- Last Synced: 2025-02-07T05:27:36.290Z (3 months ago)
- Topics: analytics, custom-aliases, express-js, full-stack-development, link-management, mern-stack, mongodb, next-js, node-js, open-source, react-js, responsive-design, tailwind-css, url-shortener, web-development
- Language: JavaScript
- Homepage: https://nanolink-official.vercel.app
- Size: 95.7 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# NanoLink
**NanoLink** is a powerful URL shortening platform designed to simplify link management and optimize sharing. Built with the **MERN stack** (MongoDB, Express.js, React.js, and Node.js) and enhanced by **Next.js**, NanoLink delivers a robust, scalable, and responsive user experience.
---
## Features
- **URL Shortening**: Generate compact, shareable links.
- **Custom Aliases**: Create personalized short URLs.
- **Analytics Dashboard**: Track link performance with detailed metrics.
- **Responsive Design**: Optimized for all devices.
- **Secure Links**: Ensure the safety and validity of shortened links.
---
## Tech Stack
### Frontend
- **Framework**: React.js
- **Styling**: Tailwind CSS
- **Enhancements**: Next.js
### Backend
- **Server**: Express.js
- **Database**: MongoDB
- **Node.js**: Server-side JavaScript runtime
### Hosting
- Frontend and backend hosted on platforms like Vercel, Heroku, or AWS.
---
## Installation
### Prerequisites
- Node.js (version 16+)
- npm or yarn
- MongoDB instance
### Steps
1. Clone the repository:
```bash
git clone https://github.com/yourusername/nanolink.git
cd nanolink
```
2. Install dependencies:
```bash
npm install
# or
yarn install
```
3. Create a `.env` file in the root directory and add the following environment variables:
```env
MONGO_URI=your_mongodb_connection_string
NEXT_PUBLIC_BASE_URL=your_base_url
JWT_SECRET=your_jwt_secret
```
4. Start the development server:
```bash
npm run dev
# or
yarn dev
```
5. Open [http://localhost:3000](http://localhost:3000) in your browser to view the application.
---
## Usage
1. Shorten URLs effortlessly.
2. Access the analytics dashboard to monitor link performance.
3. Share customized short links securely and effectively.
---
## Contributing
Contributions are welcome! Follow these steps to contribute:
1. Fork the repository.
2. Create a new branch:
```bash
git checkout -b feature/your-feature-name
```
3. Make your changes and commit them:
```bash
git commit -m "Add a meaningful commit message"
```
4. Push to your branch:
```bash
git push origin feature/your-feature-name
```
5. Create a Pull Request.
---
## Acknowledgements
- [MongoDB](https://www.mongodb.com/)
- [Express.js](https://expressjs.com/)
- [React.js](https://reactjs.org/)
- [Node.js](https://nodejs.org/)
- [Next.js](https://nextjs.org/)
- Open-source contributors
---
## Contact
For queries or suggestions, feel free to contact:
- **Email**: [email protected]
---