Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/oleg-koval/brevis
URL shortener service. Build with Serverless AWS Lambda, Atlas Mongo DB, Typescript, Node.js 14
https://github.com/oleg-koval/brevis
aws-lambda database hacktoberfest hacktoberfest2021 nodejs postman serverless typescript
Last synced: 3 months ago
JSON representation
URL shortener service. Build with Serverless AWS Lambda, Atlas Mongo DB, Typescript, Node.js 14
- Host: GitHub
- URL: https://github.com/oleg-koval/brevis
- Owner: oleg-koval
- License: mit
- Created: 2020-02-19T21:52:47.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-02-27T03:46:10.000Z (11 months ago)
- Last Synced: 2024-10-05T01:32:30.636Z (3 months ago)
- Topics: aws-lambda, database, hacktoberfest, hacktoberfest2021, nodejs, postman, serverless, typescript
- Language: TypeScript
- Homepage:
- Size: 322 KB
- Stars: 3
- Watchers: 4
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# url-shortener-service
[](http://www.serverless.com)
[](https://github.com/prettier/prettier)
[](http://commitizen.github.io/cz-cli/)
[](https://app.getpostman.com/run-collection/d52bec96f419528495c4)
## Getting Started
Functions deployed with Serverless framework to
[AWS Lambda](https://aws.amazon.com/lambda/) at
[https://7b8kyoyw1e.execute-api.us-east-1.amazonaws.com/prod](https://7b8kyoyw1e.execute-api.us-east-1.amazonaws.com/prod)
Data storage - [MongoDB Atlas](https://www.mongodb.com/cloud/atlas). Build with
[TypeScript](https://www.typescriptlang.org).
[Postman collection](https://www.getpostman.com/collections/d52bec96f419528495c4)
can be used to test endpoints locally and remotely.
| function | type | path | execution time | description |
| -------------------- | -------- | -------------- | -------------- | ------------------------------------------------------------------------------------------------------ |
| createShortUrlByHash | http | POST /hash | -//- | Request a shortened url. Even if a url was already requested it should generate a new hash. |
| getUrlByHash | http | GET /url | -//- | Get the url by using hash. |
| getStatsByUrl | http | GET /stats/url | -//- | Get the statistics of a url.List of all hashes which were generated and list of ip addresses of users. |
| cleanup | schedule | -//- | `0 0 * * ? *` | Cronjob which will delete every day at 12.00am hashes of URLs which are not longer used by 12 months. |
_The hash is made of 8 characters using charset with 64 elements, meaning there
are 64^8 combinations. It is used as an `_id` in MongoDB schema, so after
"cleanup" job hash becomes available again_
### TODO:
Some things would be great to add:
- use base62 instead of base64 encoding for url hash. Additional characters `$@`
are not "friendly" for short-url;
- add black list of urls, during creation check if url is not blacklisted or
using bloom filter;
- use cache with ttl for entries in front of database;
- alerting in slack channel;
- based on usage of `GET /stats/url` data can be stored in HDFS or similar to
enable stats being aggregated;
- setup authorization for `GET /stats/url`, make it private;
### Prerequisites
Minimal requirements to set up the project:
- [Node.js](https://nodejs.org/en) v12, installation instructions can be found
on the official website, a recommended installation option is to use
[Node Version Manager](https://github.com/creationix/nvm#readme). It can be
installed in a
[few commands](https://nodejs.org/en/download/package-manager/#nvm).
- A package manager [npm](https://www.npmjs.com). All instructions in the
documentation will follow the npm syntax.
- [Serverless](https://serverless.com/)
- [docker-compose](https://docs.docker.com/compose)
- Optionally, a [Git](https://git-scm.com) client.
### Installing
Start by cloning the repository:
```bash
git clone [email protected]:oleg-koval/brevis.git
```
In case you don't have a git client, you can get the latest version directly by
using [this link](https://github.com/oleg-koval/brevis/archive/master.zip) and
extracting the downloaded archive.
Go the the right directory and install dependencies:
```bash
cd brevis
npm install
```
Install serverless:
```bash
npm install -g serverless
```
Login to serverless:
```bash
sls login
```
That's it! You can now go to the next step.
#### Run locally
Environment is managed with [`dotenv`](https://www.npmjs.com/package/dotenv).
Rename `.env.example` to `.env`.
Environment variable **MONGODB_CONNECTION_STRING** should be present: f.e.:
`mongodb://0.0.0.0:27017/test`
Run `mongodb` container in detached mode:
```shell
docker-compose up -d
```
Run tests with coverage:
```shell
npm run test:coverage
```
Alternatively `serverless offline` can be used to run functions locally
(connection to local MongoDB or hosted should be provided):
```shell
sls offline start
```
It is possible to invoke functions locally (connection to local MongoDB or
hosted should be provided) with `sls invoke local --function `
To shutdown database without delete all containers.
```shell
docker-compose stop
```
To shutdown database and delete all containers.
```shell
docker-compose down
```
#### Run tests
## Tests
All tests are being executed using Jest. All tests files live side-to-side with
a source code and have a common suffix: `.spec.ts`. Some helper methods are
being stored in the `test` directory.
There are three helper scripts to run tests in the most common scenarios:
```bash
npm run test
npm run test:watch
npm run test:coverage
```
## Continuous Integration / Delivery
GitHub Actions are configured and run the **tests**, **linting**,
**formatting**, **spellcheck**, **types** whenever a commit is pushed to this
repository `master` or any other branch.
Also used to deploy automatically to AWS Lambda `production` after PR merged to
`master`.
### Formatting
This project uses [Prettier](https://prettier.io) to automate formatting.
```bash
npm run format
npm run format:fix
```
### Linting
This project uses [ESLint](https://eslint.org) to enable static analysis.
```bash
npm run lint
npm run lint:fix
```
### Automation
- [GitHub Actions](https://github.com/features/actions)
- [Dependabot](https://dependabot.com/)
- [Serverless](https://serverless.com)