💻 FURLS

FURLS API is an open source backend that can be deployed to any infrastructure that can run Node.js.

FURLS API works with the Flask python server framework and ReactJS as the client javascript framework

Github Stats

Contents

• Introduction
• Technology Stack
• Getting Started
  • Running FURLS API
    • Compatibility
      • Python
      • MongoDB
    • Locally
  • Running FURLS API elsewhere
    • Sample Application
• Configuration
  • Loggin
  • Installation
  • Running
• Maintainer

Introduction

FURLS is a simple URL shortener application created using the following Technology Stack. It displays a beautiful UI with proper error handling. Signing up to save and edit the shortened URLs is also supported.

⚡Technology Stack

Python

MongoDB

ReactJS

Getting Started

The fastest and easiest way to get started is to run MongoDB and FURLS API locally.

Running FURLS API

Before you start make sure you have installed:

• NodeJS that includes npm
• Python
• MongoDB
• Optionally, you can use MongoDB Atlas Cloud for your database needs. Just remember to add the DB URI in the .env file.
• Make sure you have all the environment variables configured, as mentioned in the .env.sample file.

Compatibility

Python

Version	Latest Version	Compatibility
Python --	3.6.x.-	✅ Fully compatible
Python --	3.8.x.-	✅ Fully compatible
Python --	3.9.x .-	✅ Fully compatible

ReactJS

Version	Latest Version	Compatibility
React --	16.x.-	✅ Fully compatible
React --	17.x.-	✅ Fully compatible

MongoDB

FURLS API is continuously tested with the most recent releases of MongoDB to ensure compatibility. I follow the MongoDB support schedule and only test against versions that are officially supported and have not reached their end-of-life date.

Version	Latest Version	End-of-Life Date	Compatibility
MongoDB 4.0	4.0.-	January 20-	✅ Fully compatible
MongoDB 4.2	4.2.-	TBD	✅ Fully compatible
MongoDB 4.4	4.4.-	TBD	✅ Fully compatible

Running FURLS Elsewhere

Sample Application

I have provided a basic Heroku deployed application that uses the FURLS API module on Flask adn React.JS as client and can be easily deployed to various infrastructure providers:

• Heroku
• AWS
• Google App Engine
• Microsoft Azure
• Digital Ocean

Configuration

Logging

FURLS API will, by default, log:

• to the console

Installation

Please make sure you have git installed and the prerequisites properly setup. Run the following commands to clone the project and install the necessary libraries.

$ pip install -r requirements.txt
$ cd client && npm install

Running

Using the CLI

The easiest way to run the FURLS is through the CLI:

Server

$ python app.py

Client

$ cd client
$ npm run start

👨‍💻Maintainer

Ishit Beswal