Userfriendly Link shortener with additional functions.

Table of Contents

1. Team
2. About The Project
   • Built With
3. Getting Started
   • Prerequisites
   • Installation
4. Api Documentation
5. Usage
6. Contact

Team:

• Nicole Zeh (nz015) - UI/UX
• Jann Huschka (jh259) - UI/UX/Frontend
• David Hoffmann (dh100) - Frontend
• Dennis Sebastian Schmidt (dg085) - Backend
• Joel Dettinger (jd087) - Backend

About the Project:

A Link Shortener with a clear UI and Account Authentification. The User has additional Functions if he is logged in:

If the User is not logged:

• Create a Shortened Link with a random generated Slug
• Expire Date is 30 Days

If the User is logged in:

• History of created Links
• Custom Slug for shortened Link
• Editing/Deleting created links
• Set custom Expiration date
• See View Counter on Shortened Link

(back to top)

Built With

Our project consists of three mircoservices that are communicate with each other and use different Frameworks.

Frontend

• Next.js
• React.js
• tailwindcss
• Cypress (Testing)

Backend

• node.js
• express.js
• JsonWebToken
• bcrypt
• mongoose
• jest (Testing)
• supertest (Testing)

Database

• mongoDB

Wireframe

• Figma

(back to top)

Getting Started

The project can be either run localy with node.js (Version >12) for development by starting every service manually or in Docker by running the docker-compose. But if you run it without docker you need to provide a MongoDB Database.

Prerequisites

In order to use node.js to start the project you need to be sure its installed. And also docker to run the containers.

Download Node.js

Download Docker

Installation

Before your can run the project you need to create a .env File and copy the Content from the .env.sample File into it.

Run in Docker

1. Get latest npm version

   npm install npm@latest -g

2. Clone the repository

   git clone https://gitlab.mi.hdm-stuttgart.de/mwa/ss22/saturn.git

3. Start Docker

4. Run and built Containers with docker-compose in ./ Directory

   docker-compose up

This will start the following Docker Containers:

Name	Image	Port
frontend	link24_frontend	3000
backend	link24_backend	8080
mongo	mongo:latest	27017

The Web App is now Locally available at: localhost:3000

(back to top)

API Documentation

Our endpoints are divided into three Categories:

• Authentification Documentation
• Links Documentation
• User Documentation

Wireframe

The Design of our App was created in Figma: Wireframe

Usage

Landing Page:

If you are not Logged in you have just the option to create a Link.

SignUp:

SignUp and create a Account to get additional Features.

Manage Links:

If you are logged in you can create a custom Slug for your Links or set a expire Date. You also see your history of your Links and can change the original Url or see the Views.

(back to top)

Contact

If you have Questions you can write a E-Mail to our Developers:

• Nicole Zeh: E-Mail
• Jann Huschka E-Mail
• David Hoffmann E-Mail
• Dennis Sebastian Schmidt E-Mail
• Joel Dettinger E-Mail

Project Link: GitLab

(back to top)