https://github.com/akshayraj-1/shortnx

Url Shortener using Node.js
https://github.com/akshayraj-1/shortnx

ejs javascript nodejs url-shortener

Last synced: 20 days ago
JSON representation

Url Shortener using Node.js

• Host: GitHub
• URL: https://github.com/akshayraj-1/shortnx
• Owner: akshayraj-1
• License: mit
• Created: 2024-10-20T10:50:11.000Z (2 months ago)
• Default Branch: main
• Last Pushed: 2024-12-07T09:54:14.000Z (21 days ago)
• Last Synced: 2024-12-07T10:23:57.391Z (21 days ago)
• Topics: ejs, javascript, nodejs, url-shortener
• Language: EJS
• Homepage: https://shortnx.in
• Size: 4.45 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# [WIP] Shortnx - URL Shortener

> [!WARNING] 

> This is a work in progress project. Some features may not be implemented yet.

This is a simple URL shortener that allows users to shorten their URLs. It is a simple Node.js project that uses EJS and MongoDB as the database.

**Check out the preview at:** [shortnx.in](https://shortnx.in)

## Quick Start

Follow these steps to run the project locally.

### Pre-requisites

- Node.js (v15 or higher)

- npm or yarn

### Installation

**1. Clone the repository**

```bash

git clone https://github.com/akshayraj-1/shortnx.git

cd shortnx

```

**2. Install dependencies**

```bash

npm install

```

**3. Set up the configuration file**

- Add your MongoDB URI and other required values in the `.env.development` and `.env.production` file.

- Add your `Google Client ID`, `Google Client Secret` for the [Google OAuth 2.0](https://developers.google.com/identity/protocols/oauth2) authentication in the `.env.development` and `.env.production` file.

### Run the development server

```bash

npm run dev

```

_This will start the server by default locally at port 3939_