This project was bootstrapped with Create Serverless Stack. For any customisation please refer to its documentation.
The goal of the project is to create a baseline for a simple url shortner service, using only Lambda functions. This application is hardly usable as-it-is, but for sure it covers already a long path!
- Uses AWS Lambda functions
- Uses a Dynamodb table (but doesn't track visitor's information)
- Directly serves the needed html and css (bundled with lambda)
- Uses sst for faster (and funnier) development
- Shortening is done using a Bijective function with a minimum length of 2 characters
- Every time a url is resolved, it increases its "hit" count
- No cookies
This software is released as-is, and mostly to serve as a starting point for a more complex and feature-rich application. I haven't put too much attention to security issue (IAM roles and permissions, for example) and how to setup it to run on a custom domain. This part is left to your installation.
To try (and eventually use) this application you need a working AWS account and of course an account key to work from the terminal. Testing the application is not going to cost you any $$$, but it is always a good idea to set a cost budget in your AWS testing account to avoid bitter surprises anyway!
Start by installing the dependencies.
$ npm installConfigure it:
$ cp .env.example .env
$ cp sst.json.example sst.jsonEdit .env and sst.json to supply your configuration.
Starts the local Lambda development environment.
Once the deployment finishes, you'll be given the URL to try it out.
Build your app and synthesize your stacks.
Generates a .build/ directory with the compiled files and a .build/cdk.out/ directory with the synthesized CloudFormation stacks.
Deploy all your stacks to AWS. Or optionally deploy a specific stack.
Remove all your stacks and all of their resources from AWS. Or optionally remove a specific stack.
Runs your tests using Jest. Takes all the Jest CLI options.
The CSS and HTML files are in /src/static. They are included and bundled directly from the index.ts file. Once you change them, sst will re-bundle them for you and after some seconds you'll be able to reload the page.