Thatshort

Just a URL Shortener, nothing special actually

Table of contents

Brief Description
Built in - Technologies
Modules References
Installing Dependencies
Environmental Variables
App Routes

---

Brief Description

The idea for this project came in a moment of absolute boredom. I wanted to build something really small, which would take a small amount of time to build, so here it is. What this app does is simply get from a form the URL to shorten and return the same in a shortened form which can be used to simplify the sharing of links and documents between machines (I always hate to copy and paste the same link over and over from a machine to another, that's so annoying).

Built in - Technologies

---

Modules References

Core Functionalities

Express.JS | CORS | PostCSS | Tailwind CSS | Shadcn/ui | Prisma ORM | React.JS | Vite | React Router | React Hook Form | Zod |

Installing App Dependencies

To quickly install all modules used in this project, just run the following in your terminal and you'll be good to go!

cd backend
npm i
cd ../frontend
npm i

DISCLAIMER: in order to correctly execute this command you will need to install Node.JS in your system since it's the main requirement to run the app.

---

Environmental Variables

All the application's environmental variables are available for customization in a .env.sample script for both the backend and the frontend. Feel free to tweak the values to fit your specific needs.

IMPORTANT NOTE: in order for the environmental variables to be correctly read by dotenv, you need to rename each file to .env.

---

App Routes

All the main routes for this application start with /api/{version} and are mainly used to retrieve, add, and update values from/to the Database.

The application currently features a GET endpoint for URL retrieval, and a POST endpoint for creation.