https://github.com/vectormike/psychic-parakeet

URL Shortener built with Typescript
https://github.com/vectormike/psychic-parakeet

Last synced: 12 months ago
JSON representation

URL Shortener built with Typescript

• Host: GitHub
• URL: https://github.com/vectormike/psychic-parakeet
• Owner: Vectormike
• Created: 2021-11-18T09:25:48.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2021-12-01T17:27:48.000Z (over 4 years ago)
• Last Synced: 2025-03-28T05:43:07.674Z (about 1 year ago)
• Language: TypeScript
• Homepage:
• Size: 188 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Spleets

Simple url shortener Application with Typescript

# Pre-requisite

1. You need to have [Node.js](https://nodejs.org/en/) installed.

2. You should also install [VS Code](https://code.visualstudio.com/)

3. Install [MongoDB](https://docs.mongodb.com/manual/installation/)

4. Install [Postman](https://www.getpostman.com/apps)

# Running the application locally

1. Clone this repository

   `git clone https://github.com/Vectormike/psychic-parakeet.git`

2. Install dependencies

   `cd psychic-parakeet`

   `npm install`

3. Create a `.env` file with the same variables as `.env.example` in this repository.

   Please note that `MONGO_URL` is the connection url for MongoDB.

4. Start your MongoDB server

   `mongod`

5. Build the application

   `npm run build-ts`

6. Start the application

   `npm run start`

7. Endpoints can be accessed on `localhost:5000`.