polyApi

Demo Video

• https://youtu.be/H1-hGTzcZIM

Deploy Link

• https://damp-ravine-55671.herokuapp.com/

Table of Contents

• General Info
• Tech Stack/ Framework Used
• Getting Started
• Features
• Images

General Information

• This web application is for a user to paste a content and get a short url to share.

Tech Stack/ Framework Used

• NodeJS
• MongoDB
• Express
• REACT
• Material UI

Getting Started

The instructions for setting up project locally. To get a local copy up and follow these simple example steps.

Prerequisites

This is the list of things you need to use the software and how to install them.

• npm

  npm install npm@latest -g

Installation

1. Clone the repo

   git clone https://github.com/somenisco/polyApi.git

2. Install NPM packages for backend part

   npm install

3. Install NPM packages for frontend part

   npm run client-install

4. Add a .env file in the root folder and add the followings

   ATLAS_URI=

   for mongodb setup

5. Run application locally

   npm run dev

Features

• User can paste text snippets or documents.
• User gets a short url after pasting their content.
• The saved content have a default expiration time of 1 day. They will be automatically removed from the database.
• User can view recently created snippets.
• User can manually delete or renew the expiration time of a content url.
• User gets track of ips accessing the content url.
• User can also encrypt their content with a key.
• User can paste a url and get a short url which will redirect to the original url.

Images

• Home Page

• Recent snippets Page

• Snippet Page