https://github.com/lagleki/disposeel

https://github.com/lagleki/disposeel

Last synced: 15 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/lagleki/disposeel
• Owner: lagleki
• Created: 2024-06-09T17:15:54.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2024-06-09T17:20:32.000Z (7 months ago)
• Last Synced: 2024-10-31T13:46:09.589Z (2 months ago)
• Language: TypeScript
• Size: 545 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# How to install

For now authentication is disabled. Vulnerabilities present:

* no ddos protection

* rate limiting

* no usage of Redis/in-memory cache (unlikely necessary but using Redis INSTEAD OF Posgtres might be a feature)

* no TTL for links

# To develop locally

* install Node version manager (nvm)

* `nvm use 21`

* make sure pnpm and npx are installed

* create .env file from .env.example

* `make local-up` to boot up posgresql locally

* `cd backend && npm i` to install dependencies for the backend

* from `backend` directory `npx nx serve api` to run `api` microservice

# Testing

* make a POST request `http://localhost:8000/api/link/generate` with the body with json `{"url": "https://google.com"}`

* write out the resulting "short" value

* make a GET request `http://localhost:8000/api/link/:id` where instead of `:id` you use that short value 

# ToDo:

* deploy via terraform to save time

* ci/cd

* AWS adaptation

* better readme