README.md

DevProjects - Link shortener website

This is an open source project from DevProjects. Feedback and questions are welcome! Find the project requirements here: Link shortener website

Tech/framework used

Built with Next.js and React

Screenshots and demo

Getting Started

Link Shorty is a serverless link shortening application made with React and the Next.js framework. Hosted to netlify with Next.js Runtime Version 4 (v4.27.3) installed.

Prerequisites

• Download Node.js

Installation

To install/clone this app follow the steps below.

1. Clone the repo

   git clone https://github.com/gitmohamed/link-shorty.git

2. Install NPM packages

   cd link-shorty/
   yarn
   
   OR
   
   npm install

3. Create .env.local in the root directory, copy the code below and enter your bit.ly api key and group uid

    NEXT_BITLY_API=BITLY_API_KEY_GOES_HERE
    NEXT_BITLY_GROUPUID=BITLY_GROUP_UID_GOES_HERE

4. Run the program by typing

   yarn dev
   
   OR
   
   npm run dev

(back to top)

Roadmap

• Show screenshot of the link for confirmation
• Create typescript interface for the bit.ly return data

See the open issues for a full list of proposed features (and known issues).

(back to top)

License

MIT License