This application can be used to host a custom url shortener on your own domain using serverless and AWS. The backend uses the Serverless framework to deploy the API on AWS and to create the needed Infrastructure to add storage and authentication.
URL Shortener are offering a service to store long URLs and to make them accessible by a shorter alias URL. In this project the process to shorten URLs is to save original URLs to a Database using a unique auto incrementing ID and to make them accessible by using a BASE62 encoded version of this ID that the user can use to get redirected to the original URL. While everyone can use the redirection service to create/list/update/delete short URLs a user must be registered and authenticated.
The backend folder contains the Serverless Application that can be completely automatically deployed to AWS. The backend uses API Gateway and Lambda to provide the API, DynamoDB to provide the storage for the Short URLs and Cognito to provide authentication for the API.
The provided API offers the following endpoints: The implemented app provides the following endpoints:
GET /{shortUrlId}
Description:
Redirects the caller to the original (long) URL
GET /shortUrls
Description:
Returns a list of all short URLs created by the current user
POST /shortUrls
Description:
Creates and returns a new short URL
Body:
{
"url": "<LONG_URL>"
}
PATCH /shortUrls/{shortUrlId}
Description:
Can be used to update the title of a stored short URL
Body:
{
"title": "<NEW_TITLE>"
}
DELETE /shortUrls/{shortUrlId}
Description:
Can be used to delete a stored short URL
Note: All endpoints to Create, Read, Update and Delete short URLs are protected and require the user to be logged in and to send a JWT authentication header with every request.
The serverless.yml file contains some environment variables that can be used to customize the backend prior to deployment.
After updating the configuration you need to install the necessary dependencies by running the following command from within the backend folder:
npm install
If you do not have Serverless installed on your machine you need to install it as well:
npm install --g serverless
After installing the dependencies you can deploy the backend API on AWS (using your local AWS profile) by running the following command while still being in the backend folder:
serverless deploy -v
The frontend folder contains an Angular App that can be used to connect and to interact with the backend API. It uses amplify to authenticate with the deployed Cognito User Pool and supports Listing, Creating, Modifiying and Deleting short urls.
Before running the frontend you need to configure it to talk to your deployed backend resources. You can do this by adding the necessary values to the apps environment file that you can find in: frontend/src/environments.
E.g. a valid configuration can look like this:
awsCognitoRegion: 'us-east-1',
awsUserPoolsId: 'us-east-1_CkuRmjrkZ',
awsUserPoolsWebClientId: '4r609qk6thbvru5esem68hjja7',
shortUrlEndpoint: 'https://pp1d5gm4hl.execute-api.us-east-1.amazonaws.com/dev'
After updating the configuration you need to install the necessary dependencies by running the following command from within the frontend folder:
npm install
After installing the dependencies you can run the frontend app locally on port 4200 by running the following command while still being in the frontend folder:
npm run start