URL Shortener

Home task solution for build platform to shorten url's. Short url is a way to count the number of hits per URL, we should save the original URL and redirect to the original URL.

Built With

  • ReactJS
    • Typescript
    • Redux toolkit
    • React Hook Form
    • React Modal
  • Node JS
    • Express
    • mongoose
  • MongoDB

Getting Started

This is an example of how you may give instructions on setting up the project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

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

  • npm
    npm install npm@latest -g

Installation

  1. Get a free API Key at https://example.com
  2. Clone the repo
    git clone https://github.com/matan3sh/url-shortener.git
  3. Install NPM packages
    npm install
  4. Add this environment variables to .env
    NODE_ENV = development
    PORT = 4000
    MONGO_URI = mongodb+srv://matan3sh:testtest@sunbithometask.zspen.mongodb.net/sunbit_homeTask_db?retryWrites=true&w=majority
  5. Run Project Backend + Frontend
    npm run dev