Commit fed14b25 authored by Andre Blanke's avatar Andre Blanke
Browse files

Update README.md to newest project structure

parent cd07ed11
......@@ -16,13 +16,23 @@
├─ frontend/ # Angular frontend
│ └─ src/
│ └─ index.html
├─ shortener/ # Django backend
│ ├─ shortener/
│ │ ├─ __init__.py
│ │ ├─ settings.py
│ │ ├─ urls.py
│ │ └─ wsgi.py
│ └─ manage.py
├─ shortener/ # Spring backend Maven project
│ ├─ .mvn/wrapper/ # Maven wrapper
│ ├─ src/
│ │ ├─ main/
│ │ │ ├─ kotlin/xyz/upbshrt/shortener/
│ │ │ │ ├─ controller/ # REST endpoints
│ │ │ │ │ └─ UrlShorteningController.kt # Responsible for the / and /{id} endpoints
│ │ │ │ ├─ entity/ # Entities stored in the database via repositories
│ │ │ │ │ └─ UrlMapping.kt # A mapping from a short id to a long URL
│ │ │ │ ├─ repository/
│ │ │ │ │ └─ UrlMappingRepository.kt
│ │ │ │ └─ ShortenerApplication.kt # Starting point of the backend
│ │ │ └─ resources/application.properties
│ │ └─ test/kotlin/xyz/upbshrt/shortener/
│ ├─ mvnw # Maven wrapper executable for Unix
│ ├─ mvnw.cmd # Maven wrapper executable for Windows
│ └─ pom.xml
├─ ansible.cfg
├─ API.md
├─ README.md
......@@ -32,7 +42,7 @@
## Overview
This project realizes a basic URL shortener using Django on the backend and Angular on the frontend.
This project realizes a basic URL shortener using Spring on the backend and Angular on the frontend.
Long URLs can be entered and will then be sent to the backend which assigns a unique ID for the
provided URL. The short URL containing the ID is then returned back to the client making the request.
......@@ -42,7 +52,7 @@ Accessing the short URL will then cause a redirect to the associated long URL st
## Deployment
The project is currently deployed using an Apache Web Server instance which serves the frontend itself
and redirects requests other than `/index.html` to the Django backend.
and redirects requests other than `/index.html` to the Spring backend.
Vagrant can be used to orchestrate multiple virtual machines provisioned using Ansible with multiple
worker servers running the web server and a single server acting as a load balancer at the present time.
......
Django>=3.1.3
# Recommended way of installing the mod_wsgi Apache module that allows hosting
# any Python application implementing the WSGI specification (as done by Django,
# see wsgi.py for more information).
#
# https://modwsgi.readthedocs.io/en/master/
mod-wsgi>=4.7.1
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment