Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/vzsoares/shortener

Last synced: about 1 month ago
JSON representation

Host: GitHub
URL: https://github.com/vzsoares/shortener
Owner: vzsoares
Created: 2024-06-01T17:17:02.000Z (7 months ago)
Default Branch: prod
Last Pushed: 2024-09-18T01:29:28.000Z (3 months ago)
Last Synced: 2024-09-18T12:13:15.803Z (3 months ago)
Homepage:
Size: 12.5 MB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

        # Shortener

![GitHub watchers](https://img.shields.io/github/watchers/vzsoares/shortener?style=for-the-badge)

![GitHub forks](https://img.shields.io/github/forks/vzsoares/shortener?style=for-the-badge)

![GitHub stars](https://img.shields.io/github/stars/vzsoares/shortener?style=for-the-badge)

![GitHub release](https://img.shields.io/github/v/release/vzsoares/shortener?style=for-the-badge)

![GitHub license](https://img.shields.io/github/license/vzsoares/shortener?style=for-the-badge)

[![Connect on linkedin](https://img.shields.io/badge/Connect-grey?style=for-the-badge&logo=linkedin)](https://www.linkedin.com/in/vinicius-zenha/)







Deploy your own shortener service in the aws free tier. Made in Go with minimal dependencies. Raw HTML JS and _tailwind_ front. Main _engine_ to integrate with other internal services.

## Features 🚀

-   Fully serverless pay per request

-   Terraform infra

-   Github actions

-   Generic main engine

    -   Easily integrate using a api-key

-   Bff implementation example

### Requirements 🛠️

-   make

-   aws-cli

-   terraform

-   go

-   node

-   yarn

## Setup 🦩

Make sure to have all requirements.

local:

1. Clone the repo

2. Install node dependencies with `yarn install`

3. Copy `.env.example` to `.env.dev` and `.env.prod` and fill the values

    > Some values only exist after running Terraform apply

1. configure aws credentials

4. Configure your runner in `nx.json tasksRunnerOptions`

5. ⚠️Configure the Terraform provider `backend` by changing or removing the `provider.tf backend` section in each environment

6. export AWS_PROFILE={your-profile}

7. Deploy **once** with `nx run shortener:first-deploy:dev` and `nx run shortener:first-deploy:prod`

8. Get the cloudfront distribution id and put it on your envs

9. Finally deploy with `nx run shortener:deploy:dev` and `nx run shortener:deploy:prod`

github actions:

- configure a `prod` and `dev` environment with:

  - secrets:

    - AWS_ACCESS_KEY_ID

    - AWS_PROFILE

    - AWS_REGION

    - AWS_SECRET_ACCESS_KEY

  - variables:

    > same as .env

    - API_BASE_URL

    - API_BASE_URL_DOMAIN

    - ARTIFACTS_BUCKET_NAME

    - DYNAMO_URL_TABLE_NAME

    - FRONT_BASE_URL

    - FRONT_BASE_URL_DOMAIN

    - FRONT_BUCKET_NAME

    - FRONT_CLOUDFRONT_DISTRIBUTION_ID

    - GATEWAY_API_NAME

    - NX_RUNNER

    - STAGE

## Usage ☃️

See all available commands bellow and use with: `nx run {project}:{task}:{environment}`.

Ex: `nx run engine:serve:dev` to start a local api.

| Projects    | Tasks                                                   |

|--------------|----------------------------------------------------------|

| engine        | build, lint, serve, test, tidy                           |

| front        | build, lint, publish, serve, test, tidy                  |

| public-api   | build, lint, serve, test, tidy                           |

| utils        | lint, test, tidy                                         |

| shortener    | deploy, first-deploy                                     |

## Architecture 🎨

See in [/docs](/docs)

| [![deployment](./static/hero.jpg)](./docs/deployment.md)                   | [![sequence](./static/sequence_ex.png)](./docs/sequence.md)                   |

| -------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |

| [![entity](./static/entity_ex.png)](./docs/entity.md)                | [![usecase](./static/usecase_ex.png)](./docs/use-case.md)                |

| [![swagger_p](./static/swagger_public_ex.png)](./docs/swagger-public-api.yml)                    | [![swagger_e](./static/swagger_engine_ex.png)](./docs/swagger-engine.yml)                    |