https://github.com/akshayraj-1/url-shortener

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

ejs javascript nodejs url-shortener

Last synced: about 3 hours ago
JSON representation

Url Shortener using Node.js

• Host: GitHub
• URL: https://github.com/akshayraj-1/url-shortener
• Owner: akshayraj-1
• License: mit
• Created: 2024-10-20T10:50:11.000Z (28 days ago)
• Default Branch: main
• Last Pushed: 2024-11-16T18:34:59.000Z (about 19 hours ago)
• Last Synced: 2024-11-16T19:29:58.522Z (about 18 hours ago)
• Topics: ejs, javascript, nodejs, url-shortener
• Language: JavaScript
• Homepage:
• Size: 2.45 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# [WIP] 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.

## 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/url-shortener.git

cd url-shortener

```

**2. Install dependencies**

```bash

npm install

```

**3. Set up the configuration file**

- Add your MongoDB connection string and other required values in the `src/.env.development` or `src/.env.production` file.

- Add your firebase project configuration json file in the `src/configs/` folder with name `firebase-config.json`. Learn more about firebase configuration json file [here](https://firebase.google.com/docs/web/learn-more#config-object).

- Add your firebase service account json file in the `src/configs/` folder with name `firebase-service-account.json`. Learn more about firebase service account json file [here](https://firebase.google.com/docs/admin/setup#initialize_the_sdk).

### Run the development server

```bash

npm run dev

```

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